README.md

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 📊 ERD Diagram
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 Apartment reservation

Apartment reservation is an application that allows users to rent apartments all over the world.

🛠 Built With

Tech Stack

Client

• React

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• User account creation
• Adding housing units
• Housing unit reservation

(back to top)

🚀 Live Demo

This project has no live demo, as it stands for the back-end part of the application

(back to top)

📊 ERD Diagram

This is the base ERD diagram for this project

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

 gem install rails

Setup

Clone this repository to your desired folder:

  git https://github.com/BucurEva87/apartment-reservation-back-end.git
  cd apartment-reservation-back-end

Install

Install this project with:

  bundle install
  rails db:create
  rails db:migrate
  rails db:seed

Usage

To run the project, execute the following command:

  rails server

(back to top)

👥 Authors

👤 Abdallah Antony

• GitHub: @abdallahmalima
• Twitter: @softmal1
• LinkedIn: Abdallah Antony

👤 Eva-Lavinia Bucur

• GitHub: @BucurEva87
• Twitter: @BucurEva
• LinkedIn: Eva-Lavinia Bucur

👤 Jonathan Munamire

• GitHub: @jonathanmunamire
• Twitter: @amanimunamire
• LinkedIn: Jonathan Munamire

👤 Sergiy Shkolnik

• GitHub: SergSkol
• Twitter: @sps676
• LinkedIn: SergSkol

👤 KIDDE GEORGE WILLIAM

• GitHub: @githubhandle
• Linkedin: @linkedinhandle
• Twitter: @twitterhandle

(back to top)

🔭 Future Features

Describe 1 - 3 features you will add to the project.

• User account creation
• Adding housing units
• Housing unit reservation

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, please give us a star. It would (and will) be highly appreciated! ^_^

(back to top)

🙏 Acknowledgments

I would like to thank the Rails community for giving us extensive documentation!

(back to top)

📝 License

This project is MIT licensed.

(back to top)