# khadija10/realstateai architecture

> Architecture diagram of the GitHub repository khadija10/realstateai, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-04). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/khadija10/realstateai
- Repository: https://github.com/khadija10/realstateai

## Overview

RealStateAI is a French real-estate decision-support prototype. Its central user journey is to enter property details in the estimation interface, send requests through the shared API client to FastAPI, and receive a DVF-based estimate. The product also exposes market trends, financing dossiers, capital-gains calculations, and estimation history. A separate data pipeline ingests and enriches DVF data; financing calculations have their own domain package. Connections among unsampled page implementations and backend endpoints are limited to documented or indexed evidence.

Main entry points: [`Frontend/src/App.jsx`](https://github.com/khadija10/realstateai/blob/main/Frontend/src/App.jsx) (Page router), [`Backend/main.py`](https://github.com/khadija10/realstateai/blob/main/Backend/main.py) (FastAPI endpoints), [`Frontend/src/api/client.js`](https://github.com/khadija10/realstateai/blob/main/Frontend/src/api/client.js) (HTTP client), [`data-pipeline/src/realstate_data/pipeline.py`](https://github.com/khadija10/realstateai/blob/main/data-pipeline/src/realstate_data/pipeline.py) (Pipeline orchestrator)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_frontend["Web application"]
  node_app["Page router<br/>[App.jsx]"]
  node_estimate_page["Estimation page<br/>[EstimationPage.jsx]"]
  node_market_page["Market pages<br/>[MarchePage.jsx]"]
  node_finance_page["Financing page"]
  node_plusvalue_page["Capital gains<br/>[PlusValuePage.jsx]"]
  node_history_page["Estimation history<br/>[HistoriquePage.jsx]"]
  node_api_client["HTTP client<br/>[client.js]"]
end

subgraph group_backend["API and estimation"]
  node_backend_api["FastAPI endpoints<br/>[main.py]"]
  node_address["Address parsing<br/>[address_parser.py]"]
  node_dvf_search["DVF search<br/>[dvf_search.py]"]
  node_price_calc["Price calculation"]
  node_fin_api["Financing endpoints<br/>[financing_api.py]"]
end

subgraph group_data["Property data"]
  node_dvf_files[("DVF records")]
  node_pipeline["Pipeline orchestrator<br/>[pipeline.py]"]
  node_ingestion["DVF ingestion<br/>[dvf_downloader.py]"]
  node_silver["Cleaning and dedup<br/>[silver.py]"]
  node_enrichment["Data enrichment"]
  node_gold["Feature building<br/>[gold.py]"]
  node_quality["Quality checks<br/>[validators.py]"]
end

subgraph group_finance["Financing domain"]
  node_finance_engine["Loan dossier<br/>[dossier.py]"]
  node_finance_agent["Financing agent<br/>[agent.py]"]
  node_finance_calc["Loan calculations<br/>[moteur.py]"]
  node_finance_models["Borrower models<br/>[modeles.py]"]
end

subgraph group_ml["Model lifecycle"]
  node_ml_estimator["Model estimation<br/>[estimator.py]"]
  node_ml_training["Model training<br/>[train.py]"]
  node_ml_monitor["Model monitoring<br/>[monitoring.py]"]
end

node_user(("Property seeker"))

node_user -->|"uses"| node_app
node_app -->|"routes to"| node_estimate_page
node_app -->|"routes to"| node_market_page
node_app -->|"routes to"| node_finance_page
node_app -->|"routes to"| node_plusvalue_page
node_app -->|"routes to"| node_history_page
node_estimate_page -.->|"requests via"| node_api_client
node_market_page -.->|"requests via"| node_api_client
node_finance_page -.->|"requests via"| node_api_client
node_plusvalue_page -.->|"requests via"| node_api_client
node_history_page -.->|"requests via"| node_api_client
node_api_client -->|"sends HTTP"| node_backend_api
node_backend_api -->|"uses parser"| node_address
node_backend_api -->|"calls search"| node_dvf_search
node_backend_api -->|"calls calculation"| node_price_calc
node_backend_api -->|"registers routes"| node_fin_api
node_pipeline -->|"dispatches"| node_ingestion
node_pipeline -->|"dispatches"| node_silver
node_pipeline -->|"dispatches"| node_gold
node_pipeline -->|"dispatches"| node_quality
node_pipeline -->|"dispatches"| node_enrichment
node_gold -->|"imports"| node_silver
node_ingestion -.->|"downloads"| node_dvf_files
node_dvf_files -->|"loads DVF"| node_backend_api
node_fin_api -->|"generates dossier"| node_finance_engine
node_finance_engine -->|"uses calculations"| node_finance_calc
node_finance_engine -->|"uses models"| node_finance_models
node_finance_agent -->|"uses tools"| node_finance_calc
node_ml_training -.->|"trains model"| node_ml_estimator
node_ml_monitor -.->|"monitors model"| node_ml_estimator

click node_app "https://github.com/khadija10/realstateai/blob/main/Frontend/src/App.jsx"
click node_estimate_page "https://github.com/khadija10/realstateai/blob/main/Frontend/src/pages/EstimationPage.jsx"
click node_market_page "https://github.com/khadija10/realstateai/blob/main/Frontend/src/pages/MarchePage.jsx"
click node_finance_page "https://github.com/khadija10/realstateai/blob/main/Frontend/src/pages/FinancementPage.jsx"
click node_plusvalue_page "https://github.com/khadija10/realstateai/blob/main/Frontend/src/pages/PlusValuePage.jsx"
click node_history_page "https://github.com/khadija10/realstateai/blob/main/Frontend/src/pages/HistoriquePage.jsx"
click node_api_client "https://github.com/khadija10/realstateai/blob/main/Frontend/src/api/client.js"
click node_backend_api "https://github.com/khadija10/realstateai/blob/main/Backend/main.py"
click node_address "https://github.com/khadija10/realstateai/blob/main/Backend/utils/address_parser.py"
click node_dvf_search "https://github.com/khadija10/realstateai/blob/main/Backend/utils/dvf_search.py"
click node_price_calc "https://github.com/khadija10/realstateai/blob/main/Backend/utils/price_calculation.py"
click node_fin_api "https://github.com/khadija10/realstateai/blob/main/Backend/financing_api.py"
click node_pipeline "https://github.com/khadija10/realstateai/blob/main/data-pipeline/src/realstate_data/pipeline.py"
click node_ingestion "https://github.com/khadija10/realstateai/blob/main/data-pipeline/src/realstate_data/ingestion/dvf_downloader.py"
click node_silver "https://github.com/khadija10/realstateai/blob/main/data-pipeline/src/realstate_data/cleaning/silver.py"
click node_enrichment "https://github.com/khadija10/realstateai/tree/main/data-pipeline/src/realstate_data/enrichment"
click node_gold "https://github.com/khadija10/realstateai/blob/main/data-pipeline/src/realstate_data/features/gold.py"
click node_quality "https://github.com/khadija10/realstateai/blob/main/data-pipeline/src/realstate_data/quality/validators.py"
click node_finance_engine "https://github.com/khadija10/realstateai/blob/main/financement/src/realstate_financement/dossier.py"
click node_finance_agent "https://github.com/khadija10/realstateai/blob/main/financement/src/realstate_financement/agent.py"
click node_finance_calc "https://github.com/khadija10/realstateai/blob/main/financement/src/realstate_financement/moteur.py"
click node_finance_models "https://github.com/khadija10/realstateai/blob/main/financement/src/realstate_financement/modeles.py"
click node_ml_estimator "https://github.com/khadija10/realstateai/blob/main/ml/estimator.py"
click node_ml_training "https://github.com/khadija10/realstateai/blob/main/ml/train.py"
click node_ml_monitor "https://github.com/khadija10/realstateai/blob/main/ml/monitoring.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_app,node_estimate_page,node_market_page,node_finance_page,node_plusvalue_page,node_history_page,node_api_client toneBlue
class node_backend_api,node_address,node_dvf_search,node_price_calc,node_fin_api toneAmber
class node_dvf_files,node_pipeline,node_ingestion,node_silver,node_enrichment,node_gold,node_quality toneMint
class node_finance_engine,node_finance_agent,node_finance_calc,node_finance_models toneRose
class node_ml_estimator,node_ml_training,node_ml_monitor,node_user toneIndigo
```

## Components

### Web application

- [Page router](https://github.com/khadija10/realstateai/blob/main/Frontend/src/App.jsx): `Frontend/src/App.jsx`
- [Estimation page](https://github.com/khadija10/realstateai/blob/main/Frontend/src/pages/EstimationPage.jsx): `Frontend/src/pages/EstimationPage.jsx`
- [Market pages](https://github.com/khadija10/realstateai/blob/main/Frontend/src/pages/MarchePage.jsx): `Frontend/src/pages/MarchePage.jsx`
- [Financing page](https://github.com/khadija10/realstateai/blob/main/Frontend/src/pages/FinancementPage.jsx): `Frontend/src/pages/FinancementPage.jsx`
- [Capital gains](https://github.com/khadija10/realstateai/blob/main/Frontend/src/pages/PlusValuePage.jsx): `Frontend/src/pages/PlusValuePage.jsx`
- [Estimation history](https://github.com/khadija10/realstateai/blob/main/Frontend/src/pages/HistoriquePage.jsx): `Frontend/src/pages/HistoriquePage.jsx`
- [HTTP client](https://github.com/khadija10/realstateai/blob/main/Frontend/src/api/client.js): `Frontend/src/api/client.js`

### API and estimation

- [FastAPI endpoints](https://github.com/khadija10/realstateai/blob/main/Backend/main.py): `Backend/main.py`
- [Address parsing](https://github.com/khadija10/realstateai/blob/main/Backend/utils/address_parser.py): `Backend/utils/address_parser.py`
- [DVF search](https://github.com/khadija10/realstateai/blob/main/Backend/utils/dvf_search.py): `Backend/utils/dvf_search.py`
- [Price calculation](https://github.com/khadija10/realstateai/blob/main/Backend/utils/price_calculation.py): `Backend/utils/price_calculation.py`
- [Financing endpoints](https://github.com/khadija10/realstateai/blob/main/Backend/financing_api.py): `Backend/financing_api.py`

### Property data

- **DVF records**
- [Pipeline orchestrator](https://github.com/khadija10/realstateai/blob/main/data-pipeline/src/realstate_data/pipeline.py): `data-pipeline/src/realstate_data/pipeline.py`
- [DVF ingestion](https://github.com/khadija10/realstateai/blob/main/data-pipeline/src/realstate_data/ingestion/dvf_downloader.py): `data-pipeline/src/realstate_data/ingestion/dvf_downloader.py`
- [Cleaning and dedup](https://github.com/khadija10/realstateai/blob/main/data-pipeline/src/realstate_data/cleaning/silver.py): `data-pipeline/src/realstate_data/cleaning/silver.py`
- [Data enrichment](https://github.com/khadija10/realstateai/tree/main/data-pipeline/src/realstate_data/enrichment): `data-pipeline/src/realstate_data/enrichment`
- [Feature building](https://github.com/khadija10/realstateai/blob/main/data-pipeline/src/realstate_data/features/gold.py): `data-pipeline/src/realstate_data/features/gold.py`
- [Quality checks](https://github.com/khadija10/realstateai/blob/main/data-pipeline/src/realstate_data/quality/validators.py): `data-pipeline/src/realstate_data/quality/validators.py`

### Financing domain

- [Loan dossier](https://github.com/khadija10/realstateai/blob/main/financement/src/realstate_financement/dossier.py): `financement/src/realstate_financement/dossier.py`
- [Financing agent](https://github.com/khadija10/realstateai/blob/main/financement/src/realstate_financement/agent.py): `financement/src/realstate_financement/agent.py`
- [Loan calculations](https://github.com/khadija10/realstateai/blob/main/financement/src/realstate_financement/moteur.py): `financement/src/realstate_financement/moteur.py`
- [Borrower models](https://github.com/khadija10/realstateai/blob/main/financement/src/realstate_financement/modeles.py): `financement/src/realstate_financement/modeles.py`

### Model lifecycle

- [Model estimation](https://github.com/khadija10/realstateai/blob/main/ml/estimator.py): `ml/estimator.py`
- [Model training](https://github.com/khadija10/realstateai/blob/main/ml/train.py): `ml/train.py`
- [Model monitoring](https://github.com/khadija10/realstateai/blob/main/ml/monitoring.py): `ml/monitoring.py`

### Other components

- **Property seeker**

## Connections

- Property seeker → Page router: uses (evidence: `Frontend/src/App.jsx`)
- Page router → Estimation page: routes to (evidence: `Frontend/src/App.jsx`)
- Page router → Market pages: routes to (evidence: `Frontend/src/App.jsx`)
- Page router → Financing page: routes to (evidence: `Frontend/src/App.jsx`)
- Page router → Capital gains: routes to (evidence: `Frontend/src/App.jsx`)
- Page router → Estimation history: routes to (evidence: `Frontend/src/App.jsx`)
- Estimation page → HTTP client: requests via
- Market pages → HTTP client: requests via
- Financing page → HTTP client: requests via
- Capital gains → HTTP client: requests via
- Estimation history → HTTP client: requests via
- HTTP client → FastAPI endpoints: sends HTTP (evidence: `Frontend/src/api/client.js`)
- FastAPI endpoints → Address parsing: uses parser (evidence: `Backend/main.py`)
- FastAPI endpoints → DVF search: calls search (evidence: `Backend/main.py`)
- FastAPI endpoints → Price calculation: calls calculation (evidence: `Backend/main.py`)
- FastAPI endpoints → Financing endpoints: registers routes (evidence: `Backend/main.py`)
- Pipeline orchestrator → DVF ingestion: dispatches (evidence: `data-pipeline/src/realstate_data/pipeline.py`)
- Pipeline orchestrator → Cleaning and dedup: dispatches (evidence: `data-pipeline/src/realstate_data/pipeline.py`)
- Pipeline orchestrator → Feature building: dispatches (evidence: `data-pipeline/src/realstate_data/pipeline.py`)
- Pipeline orchestrator → Quality checks: dispatches (evidence: `data-pipeline/src/realstate_data/pipeline.py`)
- Pipeline orchestrator → Data enrichment: dispatches (evidence: `data-pipeline/src/realstate_data/pipeline.py`)
- Feature building → Cleaning and dedup: imports (evidence: `data-pipeline/src/realstate_data/features/gold.py`)
- DVF ingestion → DVF records: downloads
- DVF records → FastAPI endpoints: loads DVF (evidence: `README.md`)
- Financing endpoints → Loan dossier: generates dossier (evidence: `Backend/financing_api.py`)
- Loan dossier → Loan calculations: uses calculations (evidence: `financement/src/realstate_financement/dossier.py`)
- Loan dossier → Borrower models: uses models (evidence: `financement/src/realstate_financement/dossier.py`)
- Financing agent → Loan calculations: uses tools (evidence: `financement/src/realstate_financement/agent.py`)
- Model training → Model estimation: trains model
- Model monitoring → Model estimation: monitors model
