codecaiine / lunar-hotel-backend

This project is about creating API end point using Ruby on Rails and deploying the API on heroku. The API has rooms and reservations endpoints. The API also has authentication and authorization for the user. The API is used in our front end React project which is based on an app to book a room in Lunar hotel.

LUNAR HOTEL BACKEND

This project is about creating API end point using Ruby on Rails and deploying the API on heroku. The API has rooms and reservations endpoints. The API also has authentication and authorization for the user. The API is used in our front end React project which is based on an app to book a room in Lunar hotel.

The learning objective of this project are

• Create rails app
• Connect react front end app to rails back end
• Use API end point to get data
• Fetch data from the API

Deployment

• Click here to view the documentation of the Lunar Hotel API.

Kanban board

• Click this link to view the Kanban board that was used while building this app.

• Click here to view the initial state of our Kanban board.

• At the end of this project, there are four(4) people in the team.

Built With

• Ruby on Rails
• Rswag

Getting Started

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

Prerequisites

• Ruby on Rails
• [Rswag]https://github.com/rswag/rswag)

Setup

• git clone [e-mail]:medaminedev66/lunar-hotel-backend.git

• cd lunar-hotel-backend

Running The App

• Run bundle install to install all the necessary gems
• Run rake db:create and rake db:migrate then run rails s
• Go to the browser and type localhost:3000 to see the app

Test

• Run gem install rspec to install Rspec,

• Run rspec spec to run all the test cases, and

• Run rspec spec/name_of_test_file.rb to run test cases individually.

API Documentation

• Used Rswag for the API documentation

Authors

👤 Adedamola Shittu

• GitHub: @dammyShittu
• Twitter: @aded_shittu
• LinkedIn: Adedamola Shittu

👤 Amine Smahi

• GitHub: @medaminedev66
• Twitter: @medaminesmahi
• LinkedIn: Mohammed Amine Smahi

👤 Daniel M. Matongo

• GitHub:@mmmatongo
• LinkedIn: LinkedIn

👤 Juliana Ifionu

• GitHub: @julie-ify
• LinkedIn: Juliana Ifionu

🤝 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

• Hats off to Murat Korkmaz for designing the awesome template that was used. ✨
• Microverse for giving us this chance
• The amazing code reviewers for making us improve every day 👍