/Hotelzilla-api

The back-end API for a hotel reservation app. It has endpoints for users / hotels / cities / rooms types to allow users to do auth users, CRUD hotels, make reservations.

Primary LanguageRuby

Hotelzilla-api

This is the back-end API for a hotel reservation app and here is the Front project link. It has endpoints for users / hotels / cities / rooms types to allow users to do

  • See all featured hotel rooms from the app's own external API
  • See a detailed view of each room
  • Sign up and sign in
  • If the user is logged in they can reserve a room
  • If the user is logged in they can see a list of all their reservations
  • If the user is an admin they can add or delete hotel rooms

Built With

  • Ruby
  • Ruby on Rails
  • OOP
  • SQL Postgres

Getting Started

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 "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 you have the ability to establish 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 add default data to the database.
  • Run rails s to run the application.

Tests

  • 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/, 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

Deployment

App Link

API Documentation Link

Authors

👤 Kerolous Samy

👤 Khusiima Luke Masaba

🤝 Contributing

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

Show your support

Give a ⭐️ if you like this project!

📝 License

This project is MIT licensed.