This is a RESTful API for managing the fictive 'Le repaire des chevreuils' guest house's booking system. The system allows clients to make bookings. Additionally, it provides an admin dashboard for overseeing all operations related to the guesthouse and manage guest rooms, client profiles, and bookings. The API is built using Spring Boot and follows standard REST principles, ensuring it is easy to integrate with other systems.
-
Admin Management
- Secure authentication for the admin user.
- Retrieve admin details.
-
Client Management
- CRUD operations for client profiles.
- Store and manage client information, including contact details and address.
-
Booking Management
- CRUD operations for guest bookings.
- Handle bookings with various options such as meal preferences and additional amenities.
-
Guest Room Management
- CRUD operations for guest rooms.
- Track room details, including additional features and standard equipment.
- Java 21
- Spring Boot
- Spring Data JPA
- Spring Security
- PostgreSQL
- Docker & Docker Compose
- Swagger/OpenAPI (for API documentation)
- Maven (for dependency management)
- Java 21
- Maven
- Docker & Docker Compose
-
Clone the repository:
git clone https://github.com/aReynier/repaire-chevreuils-backend.git
-
Navigate to the project directory:
cd repaire-chevreuils-backend -
If you're running the application locally, you can build and run it with Maven:
mvn clean install mvn spring-boot:run
-
Alternatively, run the application using Docker Compose:
docker-compose up -d --build
-
The API documentation is automatically generated using Swagger and is accessible at:
http://localhost:8080/swagger-ui.html
The Dockerfile and the docker-compose.yml file are configured to set up the application and its dependencies in containers. This makes it easy to spin up the entire application with a single command.
For questions or suggestions, please contact:
- Name: Aurore Reynier
- Email: reynier.aurore@gmail.com
- GitHub: https://github.com/aReynier