https://github.com/zacksff/hotel-reservation-backend
This project is a backend system for managing hotel reservations. It provides a comprehensive API for booking rooms, managing user accounts, and handling various hotel operations. The system is designed to be efficient, secure, and scalable, making it suitable for hotels of all sizes. 🧜🏻♂️
https://github.com/zacksff/hotel-reservation-backend
Last synced: 6 months ago
JSON representation
This project is a backend system for managing hotel reservations. It provides a comprehensive API for booking rooms, managing user accounts, and handling various hotel operations. The system is designed to be efficient, secure, and scalable, making it suitable for hotels of all sizes. 🧜🏻♂️
- Host: GitHub
- URL: https://github.com/zacksff/hotel-reservation-backend
- Owner: zacksfF
- License: apache-2.0
- Created: 2024-02-28T11:24:52.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-08T11:19:24.000Z (almost 2 years ago)
- Last Synced: 2025-05-16T00:42:11.113Z (11 months ago)
- Language: Go
- Homepage:
- Size: 43 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hotel reservation backend @zacksfF
## Business Problem
In the competitive hospitality industry, efficient and reliable management of hotel reservations is crucial for both customer satisfaction and operational success. Traditional reservation systems often suffer from scalability issues, limited flexibility, and difficulties in handling large volumes of concurrent users. Our Hotel Reservation Backend aims to address these challenges by leveraging modern technologies to provide a robust, scalable, and high-performance solution.
## Features
``This project contains the following features:``
- Middleware integration.
- User Authentication and Authorization: Secure login and registration system with JWT-based authentication.
- Room Management: CRUD operations for hotel rooms, including availability status and room details.
- Database support using MongoDB.
- Reservation System: Endpoints for creating, updating, and canceling reservations, with validation to ensure room availability.
- Search and Filter: Search for available rooms based on criteria such as date, room type, and price range.
- Notifications: Email notifications for booking confirmations and reminders.
- Distributed Logging and Tracing: Implementation of distributed logging and tracing to monitor and debug the application effectively.
- Integration with OpenTelemetry: Enterprise-level observability with integration to OpenTelemetry for monitoring and tracing.
- Testing patterns.
- Use of Docker, Docker Compose, and Makefiles.
- Github Actions Integration: Continuous Integration and Continuous Deployment (CI/CD) pipelines using CircleCI for automated testing, building, and deployment.
## Project environment variables
```
HTTP_LISTEN_ADDRESS=:3000
JWT_SECRET=somethingsupersecretthatNOBODYKNOWS
MONGO_DB_NAME=hotel-reservation
MONGO_DB_URL=mongodb://localhost:27017
MONGO_DB_URL_TEST=mongodb://localhost:27017
```
## Project outline
- users -> book room from an hotel
- admins -> going to check reservation/bookings
- Authentication and authorization -> JWT tokens
- Hotels -> CRUD API -> JSON
- Rooms -> CRUD API -> JSON
- Scripts -> database management -> seeding, migration
## Requirements
### Mongodb driver
Documentation
```
https://mongodb.com/docs/drivers/go/current/quick-start
```
Installing mongodb client
```
go get go.mongodb.org/mongo-driver/mongo
```
### gofiber
Documentation
```
https://gofiber.io
```
Installing gofiber
```
go get github.com/gofiber/fiber/v2
```
## Docker
### Installing mongodb as a Docker container
```
docker run --name mongodb -d mongo:latest -p 27017:27017
```
## Getting Started
NB: Make sure to have docker and docker-compose installed and running. For docker installation
```
git clone https://github.com/zacksfF/Hotel-Reservation-Backend.git
cd Hotel-Reservation-Backend
code . #if you are uisng vscode
```
- Run the application:
```
go run main.go
```
### Contributing
Contributions are welcome! Please fork the repository and create a pull request with your changes. Ensure your code follows the established style and includes appropriate tests.
### License
This project is licensed under the MIT License.