- 📖 About the Project
- 💻 Getting Started
- 👥 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).
Client
Server
- Rails
Database
- [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]
- Here is the API documentation of the project Cherry Rooms API-Docs
- Here is the Frontend part of the project Cherry Rooms front-end
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
andrake 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
👤 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
- [Admin Roles and access to add New lux Rooms]
- [Keep count of rooms using addtional attribute]
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
Give a ⭐️ if you like this project!
I would like to thank:
- Microverse
- Code Reviewers
This project is MIT licensed.