README.md

📗 Table of Contents

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

📖 House Renting

House renting is a rails application where you can book rental homes. This app is created using Rails as an api and React as frontend with 5 people.

🛠 Project Links

• Frontend Repository
• Backend Repository

Tech Stack

REACT

• React
• Redux

Server

• Rails

Database

• PostgreSQL

Key Features

• A user can register and log in, so that the data is private to them.
• Book new houses
• Create houses (only for admin)

(back to top)

Kanban Board

• Kanban-Board

• [Kanban-Board initial screenshot]

• At the end of this project, we are still 5 members: @soesandarwin2201, @anyepeter, @TechnoAndy, @Alabi12, and @studiosnabeel.

(back to top)

🚀 Live Demo

• Frontend Deployed Link
• Backend Deployed Link

(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:

 In order to run this project you need:

- Command line or terminal with React installed.
- IDE such as VsCode.

Setup

Clone this repository to your desired folder(Rails):

 git clone https://https://github.com/soesandarwin2201/house-renting-backend

Clone Another repository for frontend(React). Project

 git clone https://https://github.com/soesandarwin2201/house-renting-frontend

Install

Install Rails Project with:

  cd house-renting-backend
  bundle install

  Setup database credentials
  config/database.yml

  rails db:create
  rails db:seed
  rails s

For the React project,

• Go to the respective folder where you clone.
• At the root folder of your app, Make new file called .env and add the following.

   REACT_APP_API_URL=http://127.0.0.1:3000

• Run the following.

   npm install
   npm start

👥 Authors

👤 Robert

• GitHub: @githubhandle]( https://github.com/Alabi12)
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Soe Sandar Win

• GitHub: @soesandarwin2201
• LinkedIn: LinkedIn

👤 ANYE PETER

• GitHub: @anyepeter
• Twitter: @anyepeter
• LinkedIn: peterchendi

👤 Nabeel Akbar

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Andy

• GitHub: TechnoAndy
• Twitter: @ADiegaardt
• LinkedIn: andy-diegaardt

(back to top)

🔭 Future Features

• Fully Functional Auth Pages including email verifications and forgot password pages
• Make multiple admins

(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 it a ⭐️

(back to top)

🙏 Acknowledgments

Thanks @Murat Korkmaz on Behance. for providing this template

Thanks, Microverse for giving us this opportunity.

(back to top)

📝 License

This project is MIT licensed.

(back to top)