• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
    • 🖺 Entity Relationship Diagram
  • Kanban Board
  • React Frontend
  • API Documentation
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

Cherry Rooms Backend is a luxury room rental service back-end where users can first signup and log-in and then create new rooms by filling in all the information about their luxury room, then reserve existing rooms , delete rooms, and delete reservations. It is built and connected by using two different repos, including Back-end(Rails) and Front-end(React/Redux).

• [Luxary Rooms List endpoint]
• [JWT Authorization with Devise upon login and register]
• [Authenticated Users can create/delete as removed a Room]
• [Authenticated Users can reserve/remove a Reservation]

(back to top)

• Kanban Board

(back to top)

• Here is the API documentation of the project Cherry Rooms API-Docs

(back to top)

• Here is the Frontend part of the project Cherry Rooms front-end

• Live Demo 🚀 😃

(back to top)

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

• Clone the repository to your local machine. - ** git clone https://github.com/adel-gu/Cherry-Rooms-back-end.git **

To run this project you need: Git and Ruby

 gem install rails

Install this project with:

  bundle install

Create a Database (Mandatory)

• Run rake db:create:all and rake db:migrate
• Run rake db:seed to populate the database with some sample data if you add any.
• Run rails s to start the server.
• In your browser, go to http://localhost:3000.

Run tests

bundle exec rspec

(back to top)

👤 Zuhaib Amjad

• GitHub: @Zuhaib042
• Twitter: @Zuhaib042
• LinkedIn: LinkedIn

👤 Adel Guitoun

• GitHub: @adel-gu
• Twitter: @GuitounAdel
• LinkedIn: adelguitoun

👤 Aminu Rabiu

• GitHub: @arabiu033
• LinkedIn: LinkedIn

👤 Joel Kugonza

• GitHub: @Joel-100
• Twitter: @Joel Kugonza
• LinkedIn: Joel Kugonza

(back to top)

• [Admin Roles and access to add New lux Rooms]
• [Keep count of rooms using addtional attribute]

(back to top)

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

Give a ⭐️ if you like this project!

(back to top)

I would like to thank:

• Microverse
• Code Reviewers

(back to top)

This project is MIT licensed.

(back to top)