This project is developed using Spring Boot and is designed to manage hotels, users, and ratings. It provides REST APIs to create, read, update, and delete (CRUD) hotels, users, and their ratings.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
What things you need to install the software and how to install them:
- JDK 1.8 or later
- Maven 3.2+
- Spring Boot 2.5.0 or later
- An IDE (IntelliJ, VS Code etc.)
- MySQL or any other relational database (for storing data)
A step by step series of examples that tell you how to get a development environment running:
- Clone the repository to your local machine.
- Open the project in your IDE.
- Configure
src/main/resources/application.properties
with your database connection details. - Run the project as a Spring Boot application.
The server will start on the default port 8080.
- GET
/api/v1/hotels
- Retrieve all hotels. - POST
/api/v1/addHotels
- Add a new hotel.
- GET
/api/v1/ratings
- Retrieve all ratings. - POST
/api/v1/addRatings
- Add a new rating.
- GET
/api/v1/users
- Retrieve all users. - POST
/api/v1/users
- Create a new user. - PUT
/api/v1/{userId}
- Update an existing user. - DELETE
/api/v1/{userId}
- Delete a user.
- Spring Boot - The web framework used
- Maven - Dependency Management
We use SemVer for versioning. For the versions available, see the tags on this repository.
- Rohit Shakya - Initial work - github.com/rohitshakya
This project is licensed under the MIT License - see the LICENSE.md file for details
- Hat tip to anyone whose code was used
- Inspiration
- etc