Yellow rooms have been created to save reservations of a Hotel room. This project is have been done to provide the backend to Yellow Rooms app. On this repository, we created the database with Postgresql following the ERD design...

We created it following the BDD method (Behavioral Driven Development). To improve the efficiency of our test, we add to this project a coverage gem to allow us to keep a register of the test behavior.

The coverage gem generates an HTML inform that can be found in the path YellowRooms-Back/coverage/index.html

We documented the Api's endpoints with Swagger. You can check it here.

• Ruby on Rails
• PostgresSQL
• Rspect to tests
• Swagger to create Api documentation
• Deployed in Fly

Authentication

POST  /api/v1/register
create account

POST  /api/v1/login
create session

DELETE  /api/v1/logout
delete session

Rooms

GET  /api/v1/rooms
list rooms

POST  /api/v1/rooms
create room

DELETE  /api/v1/rooms/{id}
delete room

Register

GET  /api/v1/reservations
list reservations

POST  /api/v1/reservations
create reservation

DELETE  /api/v1/reservations/{id}
delete reservation

• Install Ruby on your local machine
• Clone this repository

[email protected]:marurevi/YellowRooms-Back.git

• To get started, In the root directory run:

gem install bundler

Then run:

bundle install

Open terminal and run ruby app in the command Line:

bin/main

In case you want to run test, write the following command in your terminal:

bin/rspec

👤 Andres Agudelo

• GitHub: @anagudelogu
• Twitter: @AgudeloAndres__
• LinkedIn: Andres Agudelo Guzman

👤 Mariana Revilla Lérida

• GitHub: @marurevi
• Twitter: @MaruRevilla
• LinkedIn: Mariana-Revilla-Lérida

👤 Axel Soler

• GitHub: @AxelSoler
• LinkedIn: Axel Soler
• Twitter: Axel Soler

👤 Tadesse Alemayehu

• GitHub: @Tadess-Alemayehu
• Twitter: @TadesseWebDev
• LinkedIn: Tadesse Alemayehu

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.