Skip to content

Latest commit

 

History

History
177 lines (107 loc) · 5.21 KB

README.md

File metadata and controls

177 lines (107 loc) · 5.21 KB
Raw


HomeQuest

A Real Estate Website Built using MERN Stack.
Report Bug · Request Feature

Teamates

  1. Adya Bhat
  2. Aditya GH
Table of Contents
  1. About The Project
  2. Setting Up the Project
  3. Contributing
  4. License

About The Project

Warning
You also need to setup the Server for the project to be Functional: https://github.com/bcsamrudh/HomeQuest-backend

image

HomeQuest provides the following features:

  • Property Management: Easily add and showcase properties for sale or rent.
  • Efficient Browsing: Navigate through listings based on location, price, and filters.
  • Sorting Options: Organize results by price, date created, or number bedrooms and bathrooms.
  • Mortgage Calculator: Estimate mortgage payments for informed financial planning.
  • Area Calculator and Visualizer: Evaluate property dimensions and visualize spaces.
  • User Authentication: Secure login and registration for personalized property tracking.

(back to top)

Built With

  • Next.Js
  • Redux
  • TailwindCSS
  • NodeJS
  • Express.js
  • MongoDB
  • Firebase

(back to top)

Setting Up the Project

To set up the HomeQuest project on your local machine, follow these steps:

  1. Clone the repository to your local machine using the following command:

    git clone https://github.com/bcsamrudh/HomeQuest-Frontend

  2. Navigate to the project directory:

    cd HomeQuest-Frontend

  3. Install the project dependencies:

     npm install

  4. Start the development server:

    npm run dev

  5. Open your web browser and visit http://localhost:3000 to access HomeQuest

(back to top)

Usage

Authentication

image

Browse through Properties

image image

Properties Detail View

image

Mortgage Calculator

image

Property Area Visualiser

image

Upload Properties

image

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)