📗 Table of Contents

📖 About the Project
💻 Getting Started
- Setup
- Prerequisites
- Install
- Usage
- Run tests
- Deployment
👥 Authors
🔭 Future Features
🤝 Contributing
⭐️ Show your support
🙏 Acknowledgements
❓ FAQ
📝 License

📖 Cherry Rooms Backend

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).

🛠 Built With

Tech Stack

Client

React.js

Server

Rails

Database

PostgreSQL

Key Features

[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

Kanban Board

(back to top)

API Documentation

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

(back to top)

📇 Entity Relationship Diagram

React Frontend

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

🚀 Live Demo

Live Demo 🚀 😃

(back to top)

💻 Getting Started

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 **

Prerequisites

To run this project you need: Git and Ruby

 gem install rails

Install

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