HotelAgent API

This is the back-end API for HotelAgent, an app in which you can reserve a hotel.

The API has endpoints for users/reservations/hotels.

Read the complete documentation here.

UI Repo

Check the UI of this App here.

To get a local copy up and running follow these simple example steps.

Click on the top right green "code" button.
On the dropdown menu, choose the "download with zip" button.
After download, extract the zip file and you have the project on your machine.
Make sure that your PostgreSQL server is running and that you can establish a connection with the database.
Execute rails db:create to create the database.
Execute rails db:migrate to migrate the database.
Execute rails db:seed to migrate the database.
Run rails s to run the application.

If you want to run some unit tests, all you need to do is:
On your terminal execute: gem install rspec
Run the rspec command in this case over the path of spec/, and the resulting command will look like this: rspec spec/.
If you want to run the tests over the entire project, you can execute the following command: rspec
you can make a documentation test by just running rake rswag:specs:swaggerize .

Admin Account for Demo/testing: admin@hotmail.com (password: 123456)

In this project 3 developers have participated, connect with them in the authors section.

This was the kanban board a the beginning of the project

👤 Ahmed Adel

👤 Jorge Rios

👤 Sediqullah Badakhsh

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

Give a ⭐️ if you like this project!

This project is MIT licensed.