README.md

📗 Table of Contents

• 📗 Table of Contents
• 📖 RENT A HOUSE
  • 🛠 Built With
    • Tech Stack
    • Key Features
    • Back End app
    • Kanban
    • ScreenShots of Kanban boards
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 RENT A HOUSE

RENT A HOUSE is a react application used to rent and buy houses and uses rails api for authentication and data storage.

🛠 Built With

Tech Stack

Language

• Javascript

Libraries

• Javascript
• Reactjs
• Redux

Key Features

• See houses-List
• Rent a house
• Add houses
• Delete hosues

(back to top)

Back End app

Click here to access the back end app that was built with ruby-on-rails

Kanban

we are 3 team members:

• Click here to see the Front End Kanban project
• Click here to see the Back End Kanban project

ScreenShots of Kanban boards

🚀 Live Demo

You can see the live Rent a house here.

💻 Getting Started

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

Prerequisites

In order to run this project you need to install these prerequisites:

• If you're running on Windows you can download the prerequisites from the links down below:

Nodejs

Git

• If you're running on Linux follow these steps down below:

• Install git.

 sudo apt install git

• Install nodejs and npm.

 sudo apt install nodejs

Setup

Clone this repository to your desired folder:

  git clone git@github.com:shella12/RentAnItemApp.git
  cd RentAnItemApp

Install

Install this project with:

  npm install

Usage

To run the project, execute the following command:

npm start

Run tests

To run tests, run the following command:

  npm run test

(back to top)

👥 Authors

👤 Zuhra Hashimi

• GitHub: @ZuhRa-HashiMi
• LinkedIn: Zuhra Hashmi
• AngelList: zuhra-hashimi

👤 Ayesha Arshad

• GitHub: @shella12
• Twitter: @Ayesha Arshad
• LinkedIn: Ayesha Arshad

👤 Dicko Allasane

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

(back to top)

🔭 Future Features

• Add rating system
• Updating houses details

(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 by staring it.

(back to top)

🙏 Acknowledgments

The app is built using this Design by Alexey Savitskiy

(back to top)

📝 License

This project is MIT licensed.

(back to top)