Skip to content

Repository files navigation

Real Estate Analytics Web App

A web application for displaying real estate rent analytics data.

Code Structure Note

In the navigation menu:

  • "Apartments Rent" links to the optimized rent analytics module (located in rent_rev directories)
  • "Apartments Vacancy" links to the optimized vacancy analytics module (located in vacancy_rev directories)

Note: The rent and vacancy directories in both frontend and backend are deprecated and not in use.

Environment Setup

  1. Clone the repository
  2. Copy the environment template:
    cd backend
    cp .env.example .env
  3. Update the .env file with your Supabase credentials:
    • SUPABASE_URL: Your Supabase project URL
    • SUPABASE_KEY: Your Supabase anon key (public)

Development

Backend

  1. Create and activate virtual environment:
    python -m venv venv
    source venv/bin/activate  # Linux/Mac
    # or
    .\venv\Scripts\activate  # Windows
  2. Install dependencies:
    cd backend
    pip install -r requirements.txt
  3. Start the server:
    python run.py

Frontend

  1. Install dependencies:
    cd frontend
    npm install
  2. Start the development server:
    npm start

Security Notes

  • The application uses Supabase's Row Level Security (RLS)
  • Only read access is permitted through the anon key
  • All sensitive information should be kept in .env files
  • Never commit .env files to the repository

Releases

Packages

Used by

Contributors

Languages