# bakkeshks/homescopeca architecture

> Architecture diagram of the GitHub repository bakkeshks/homescopeca, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-09-12). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/bakkeshks/homescopeca
- Repository: https://github.com/bakkeshks/homescopeca

## Overview

##### Project type and purpose
- Type: Full-stack, server-rendered web application with an external AI/ML service.
- Purpose: Let users enter California housing features in a web form, send those to a trained MindsDB model, and display predicted house prices along with charts.

##### File structure
- app.js (Express/Node entry point)
- views/ (EJS & HTML templates: index.ejs, result.ejs, dashboard.html)
- public/ (static assets: images, CSS, client-side JS including Chart.js)
- package.json (dependencies: express, mindsdb SDK, ejs, chart.js on frontend)
- No separate database folder, because MindsDB handles data storage and model hosting.

##### README insights
- Web server runs on Node.js/Express on Linode VM.
- MindsDB runs in a Docker container, exposes ports 47334 & 47335.
- Frontend uses Bootstrap 3, EJS templates, Chart.js, and MindsDB JS SDK.
- Data flow: user → Node.js → MindsDB → Node.js → browser.

##### Main components and their relationships
a. Components:
- Web Client (Browser)
- Express/Node.js Server (app.js)
- MindsDB Server (Docker container with AI tables)
- Static Assets (public folder: CSS, images, client JS / Chart.js)
- Templates (views folder: EJS/HTML)
- External Data Source (CSV dataset, Kaggle upload into MindsDB)
- Optional: MindsDB Cloud (alternative to Docker)
b. Interactions:
1. User opens home page (HTTP GET → Node.js → serves index.ejs + static assets).
2. User submits form (HTTP POST → Node.js).
3. Node.js constructs SQL-style query and sends it to MindsDB server (over REST/HTTP or SDK).
4. MindsDB returns prediction and aggregated statistics.
5. Node.js injects results into result.ejs or dashboard.html, serves back to browser.
6. Browser renders charts via Chart.js using data inlined in the template or fetched via client SDK.
c. Architectural patterns:
- Monolithic backend with a clear “AI as a Service” boundary.
- Server-side rendering (EJS) combined with client-side charting.
- Separation of concerns: presentation (views & public), business logic (app.js), AI/ML (MindsDB).
d. Key technologies:
- Node.js + Express
- EJS template engine
- Chart.js (client)
- MindsDB (Docker or Cloud)
- Bootstrap 3 for UI
- Linode VM hosting

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Frontend Layer
    subgraph "Frontend"
        direction TB
        Browser["Browser\n(HTML/EJS + Chart.js)"]:::frontend
        StaticAssets["Static Assets\n(public/)"]:::frontend
        TemplatesIndex["Index Template\n(views/index.ejs)"]:::frontend
        TemplatesResult["Result Template\n(views/result.ejs)"]:::frontend
        TemplateDash["Dashboard Template\n(views/dashboard.html)"]:::frontend
    end

    %% Backend Layer
    subgraph "Backend Services"
        direction TB
        NodeServer["Express/Node.js Server\n(app.js)"]:::backend
        Package["Dependency Config\n(package.json)"]:::backend
        MindsDB["MindsDB AI Service\n(Docker)\nPorts: 47334, 47335"]:::service
    end

    %% External / Documentation
    subgraph "Project Docs & Data"
        direction TB
        README["Project Documentation\n(README.md)"]:::external
        LICENSE["License Info\n(LICENSE)"]:::external
        Kaggle["Kaggle Dataset\n(CSV import)"]:::external
    end

    %% Interactions
    Browser -->|HTTP GET /| NodeServer
    NodeServer -->|renders| TemplatesIndex
    NodeServer -->|serves| StaticAssets
    Browser -->|fetch static assets| StaticAssets

    Browser -->|HTTP POST /predict| NodeServer
    NodeServer -->|SQL-style query via SDK| MindsDB
    MindsDB -->|prediction JSON| NodeServer
    NodeServer -->|renders| TemplatesResult
    NodeServer -->|renders| TemplateDash
    NodeServer -->|responds HTML/JSON| Browser

    Kaggle -->|one-time import| MindsDB

    %% Click Events
    click NodeServer "https://github.com/bakkeshks/homescopeca/blob/main/app.js"
    click StaticAssets "https://github.com/bakkeshks/homescopeca/tree/main/public/"
    click TemplatesIndex "https://github.com/bakkeshks/homescopeca/blob/main/views/index.ejs"
    click TemplatesResult "https://github.com/bakkeshks/homescopeca/blob/main/views/result.ejs"
    click TemplateDash "https://github.com/bakkeshks/homescopeca/blob/main/views/dashboard.html"
    click Package "https://github.com/bakkeshks/homescopeca/blob/main/package.json"
    click README "https://github.com/bakkeshks/homescopeca/blob/main/README.md"
    click LICENSE "https://github.com/bakkeshks/homescopeca/tree/main/LICENSE"

    %% Styles
    classDef frontend fill:#E3F2FD,stroke:#90CAF9,color:#0D47A1;
    classDef backend fill:#E8F5E9,stroke:#A5D6A7,color:#1B5E20;
    classDef service fill:#FFF3E0,stroke:#FFCC80,color:#E65100;
    classDef external fill:#ECEFF1,stroke:#B0BEC5,color:#37474F;
```
