Skip to content

README.md

Latest commit

 

History

History
56 lines (47 loc) · 1.87 KB

README.md

File metadata and controls

56 lines (47 loc) · 1.87 KB
Raw

Go-REST-API

This repository contains a Go-based REST API for managing user registrations and events. It provides endpoints for user login, registration, and event management.

Technologies Used

  • Go: The primary programming language.
  • Gorilla Mux: A powerful HTTP router and URL matcher.
  • PostgreSQL: A relational database for storing user and event data.

Features

  • User registration and cancellation
  • Event creation and management
  • Secure login functionality

Installation

  1. Clone the repository: 
    git clone https://github.com/your-username/go-rest-api.git
  2. Navigate to the project directory: 
    cd go-rest-api
  3. Install dependencies: 
    go mod tidy
  4. Run the application: 
    go run main.go

Usage

The API provides the following HTTP endpoints:

  • POST /register: Register a new user.
  • POST /login: Authenticate a user.
  • POST /events: Create a new event.
  • GET /events: Retrieve all events.

Example HTTP requests can be found in the /api-test directory.

Contributing

Contributions are welcome! If you'd like to contribute, please:

  1. Fork the repository.
  2. Create a new branch for your feature or bugfix.
  3. Submit a pull request with a detailed description of your changes.

Acknowledgments

This REST API was built following along with the course by Maximilian Schwarzmüller. Thank you for the valuable insights and teachings!

Credits

Special thanks to Maximilian Schwarzmüller for creating the course that this project is based on.

License

This project is licensed under the MIT License. See the LICENSE file for details.