Skip to content

Latest commit

 

History

History
113 lines (81 loc) · 4.37 KB

README.md

File metadata and controls

113 lines (81 loc) · 4.37 KB
Raw


Rentals 4 Real
Rentals 4 Real


The realtor that searches for you.


Introduction • My Role: UX/UI Design • Inspiration • Key Features • How To Use • Credits • Sponsors •

screenshot

Introducing R4R

Rentals 4 Real is a platform that automates the housing rental search process.

My Role: UX/UI Design

Here is the Figma file.

My role as part of the team - besides from pitching and developing the idea - working on the front-end of the project, was to design and build the foundation of the website's structure and layout. I used Figma to create a basic mock-up design to then be coded using HTML, JS and CSS. Furthermore, the README, submission video and logo were all created by me.

Inspiration

We were inspired to create R4R based off our personal experiences and frustrations while searching for off-campus housing as university students.

Demo Video

Key Features

  • Live SMS Alerts - Real time house hunting
    • Get SMS alerts for properties that you have saved, so you are always on top of the house search!
  • Smart recommendations - Find your dream home
    • Our smart recommendation system will find you the best properties based on your preferences.
    • You can also filter by price, location, and more!
    • Save your favourite properties to view later.
  • Easy to use UI
    • Our simple and intuitive UI makes it easy to find your dream home.
  • Automatic property updates
    • Our database is updated daily, so you will always have the latest listings and alert you when a new one is posted.

How To Use

Requirements to Run

  • Python 3.10.X
  • Pip

Running the Program

# setting up requirements
pip install -r requirements.txt
# setting environment variables
export RentProjectMongo=<your mongo uri>
# running the program
uvicorn main:app

How It Works

We are using FastAPI's web framework to create a REST API. The API is connected to a MongoDB database, which stores all the data. The API is hosted on Heroku, and the database is hosted on MongoDB Atlas. The frontend is built using React, and is hosted on Netlify. The frontend is connected to the API using the native fetch API.

Rest API

For the complete API documentation please visit here

Sponsors

We would like to extend our gratitude to the sponsors of Deerhacks 2023, for supporting us in bringing this project back to life.

Twilio

Domain.Com

mlh.io

Credits

This website uses the following packages:

Team

Usha Sophea Janardhan
Usha Sophea Janardhan
 Niti Chaudhary
Niti Chaudhary
 Ido Ben Haim
Ido Ben Haim
 Justin Young
Justin Young