Skip to content

Latest commit

 

History

History
155 lines (102 loc) · 3.81 KB

README.md

File metadata and controls

155 lines (102 loc) · 3.81 KB

Real Estate Advisor

An application that provides real estate insights and predictions based on busyness data.

Reiah: Real Estate Investment Analyser and Helper

Welcome to Reiah, a powerful web application designed to streamline the process of real estate investment. Whether you're a homebuyer looking for the perfect neighborhood or a commercial investor seeking the ideal location for your next venture, Reiah has you covered.

Features

  • Personalized Recommendations: Get tailored suggestions for residential areas that match your preferences and lifestyle.
  • Commercial Property Analysis: Identify prime locations for commercial investments, such as restaurants, offices, and retail spaces.
  • Future Property Evaluation: Access estimates and projections for future property values to make informed investment decisions.

Technology Stack

  • Backend: Built with GoLang, ensuring robust performance and scalability.
  • Frontend: Developed using Solid.js, providing a seamless and responsive user experience.
  • API Integration: FastAPI connects the frontend and backend, enabling efficient and smooth data flow.

Why Choose Reiah?

Reiah leverages advanced algorithms and data analysis to provide you with the most relevant and accurate information for your real estate investment needs. Our user-friendly interface and comprehensive features make it easier than ever to navigate the complex world of real estate.

Join us on our journey to simplify real estate investment and help you make the best decisions for your future.

Table of Contents

Getting Started

Follow these instructions to set up the project locally.

Prerequisites

Making sure you have the following software installed:

  • Python 3.9 or higher
  • Git
  • Node.js and npm
  • Docker (optional, for Docker setup)
  • Virtualenv (optional, but recommended)

Installation

1. Clone the Repository

git clone https://github.com/your-username/your-repo-name.git
cd your-repo-name

2. Create and Activate Virtual Environment

  • On Unix or macOS:

    python3 -m venv backend/venv
source backend/venv/bin/activate

  • On Windows:

    python -m venv backend\\venv
backend\\venv\\Scripts\\activate

3. Install Backend Requirements

pip install -r backend/requirements.txt

4. Set Up Environment Variables

Create a .env file in the backend directory and add the necessary environment variables:

cd backend
touch .env

Then open the .env file and add the following content:

DATABASE_URL=postgresql://user:password@localhost/real_estate

Running the Backend

1. Navigate to Backend Directory

cd backend

2. Run the FastAPI Application

uvicorn app.main:app --reload --host 0.0.0.0 --port 8000

The backend should now be running on http://0.0.0.0:8000.

Running the Frontend

1. Navigate to Frontend Directory

cd ../frontend

2. Install Frontend Dependencies

npm install

3. Run the Frontend Application

npm start

The frontend should now be running on http://localhost:3000.

Docker Setup

To use Docker, follow these steps:

1. Build and Run the Containers

docker-compose up --build

This will build and run the backend, frontend, and database containers.

Contributing

Follow these steps:

  1. Fork the repository
  2. Create a new branch (git checkout -b feature-branch)
  3. Commit your changes (git commit -m 'Add some feature')
  4. Push to the branch (git push origin feature-branch)
  5. Open a pull request