BertrandConxy/Premium-hotel-backend

Premium hotel API built with Ruby in Rails. It is deployed on Heroku.

Premium Hotels API

This is the API for the premium hotel web application. It allows users to browse various kinds of rooms available in our hotel anywhere they are and they can be able to reserve any room they want.

Built with

• Ruby
• Ruby on Rails
• Gems
  • Rspec
  • Capybara
  • Swagger-UI
  • JWT Authentication
  • Selenium-webdriver
  • cancancan
  • Devise
  • FactoryBot
  • Faker
  • Rack cors

Get Started

Follow these steps below:

Pre-requisites

- Ruby
- Rails
- PostgreSQL

Setup

Clone the repo and run bundle install in the command line to install the dependencies

$ git clone https://github.com/kingqabil/book-an-appointment-backend.git
$ cd book-an-appointment-backend

Install gems with:

$ bundle install

Run test on project with

$ rspec
  - this will run all the test cases

$ rspec spec/folder_name/name_of_test_file.rb
  - to run test cases individually

Start rails server (puma)

$ rails server

Open http://localhost:3001/ in your browser

API Documentation using Swagger-UI

Open https://premium-hotel.herokuapp.com/index.html in your browser

Author

👤 SadiQ HabiL

• GitHub: @kingqabil
• Twitter: @kingqabil
• LinkedIn: @kingqabil

👤 Hamza Tarar

• GitHub: @Lockless404
• Twitter: @hamza_tarar10
• LinkedIn: Hamza Tarar

👤 Bertrand Mutangana Ishimwe

• GitHub: @BertrandConxy
• Twitter: @Bconxy
• LinkedIn: Bertrand Mutangana Ishimwe

🤝 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!

Acknowledgments

• Hat tip to anyone whose code was used
• Thanks to Microverse

📝 License

This project is MIT licensed.