# nourah-alotaibi/gp architecture

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

- Interactive diagram: https://gitdiagram.com/nourah-alotaibi/gp
- Repository: https://github.com/nourah-alotaibi/gp

## Overview

##### Project Type and Purpose
- This is a full-stack web application for recommending epilepsy treatment plans using a machine-learning model.
- The React-based frontend provides an interface for doctors to upload patient data (Excel/CSV) and view predictions.
- The Flask-based backend exposes REST endpoints, handles file uploads, runs preprocessing and the ML inference pipeline, and returns treatment recommendations.

##### File Structure Analysis
- Top-level:
- backend/: Contains Flask API (app.py, minimal_server.py, simple_server.py), ML utilities (severity_engine.py, create_sample_data.py), tests, environment scripts, and an uploads/ folder for incoming files.
- frontend/: Contains React app, package.json, node_modules/.
- data/: Holds training and sample datasets (Excel, CSV).
- venv/ and backend/venv: Python virtual environments.
- Key patterns:
- REST API layer (Flask app).
- ML “engine” module (severity_engine.py + data extractors).
- File-based I/O for uploads and sample data.
- Frontend-backend separation via HTTP (CORS configured).

##### Architecturally Relevant README Insights
- Backend runs on http://localhost:5000, React on http://localhost:3000.
- Emphasis on file‐format requirements, optional sample generation, and troubleshooting.
- No external databases—data is loaded from data/ and persisted temporarily to backend/uploads/.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Frontend Layer
    subgraph "Frontend Layer"
        direction TB
        Browser["Client Browser"]:::frontend
        ReactApp["React SPA"]:::frontend
        FrontendConfig["package.json"]:::frontend
    end

    %% Backend Layer
    subgraph "Backend/API Layer"
        direction TB
        FlaskApp["Flask API (app.py)"]:::backend
        AltEntrypoints["Alternative Entry Points"]:::backend
        CORSChecker["check_env.py"]:::backend
        FileIO["Uploads Folder"]:::data
        subgraph "ML Inference Engine"
            direction TB
            SeverityEngine["severity_engine.py"]:::ml
            Preprocessing["extract_treatment_categories.py\nand debug_encoders.py"]:::ml
        end
        subgraph "Data Store"
            direction TB
            TrainingData["Filtered_Structured_Dataset_TextLabels.xlsx"]:::data
            TemplateData["eplipsey_data_template.xlsx"]:::data
        end
    end

    %% Dev/Tools Layer
    subgraph "Dev/Tools & Utilities"
        direction TB
        SampleGen["create_sample_data.py\ncreate_sample.py\ncreate_numeric_sample.py\ncreate_exact_sample.py"]:::tools
        Tests["test_model.py\ndiagnose_issue.py\ntest_server.py\nsimple_test.py"]:::tools
        Docs["HOW_TO_RUN.md\nIMPORTANT_INSTRUCTIONS.md\nREADME.md"]:::tools
        Requirements["requirements.txt"]:::tools
        StartupScripts["start_server.sh\nstart_server.bat"]:::tools
    end

    %% Connections
    Browser -->|"loads"| ReactApp
    ReactApp -->|"reads package.json"| FrontendConfig
    ReactApp -->|GET /template| FlaskApp
    ReactApp -->|POST /upload| FlaskApp

    FlaskApp -->|uses| CORSChecker
    FlaskApp -->|invokes| SeverityEngine
    FlaskApp -->|invokes| Preprocessing
    FlaskApp -->|saves file to| FileIO
    FlaskApp -->|reads template| TemplateData
    SeverityEngine -->|loads training data| TrainingData

    SampleGen --- Docs
    Tests --- Docs
    FlaskApp --- Requirements
    FlaskApp --- StartupScripts

    %% Click Events
    click Browser "https://github.com/nourah-alotaibi/gp/tree/main/frontend/"
    click ReactApp "https://github.com/nourah-alotaibi/gp/tree/main/frontend/"
    click FrontendConfig "https://github.com/nourah-alotaibi/gp/blob/main/frontend/package.json"
    click FlaskApp "https://github.com/nourah-alotaibi/gp/blob/main/backend/app.py"
    click AltEntrypoints "https://github.com/nourah-alotaibi/gp/blob/main/backend/minimal_server.py"
    click AltEntrypoints "https://github.com/nourah-alotaibi/gp/blob/main/backend/simple_server.py"
    click AltEntrypoints "https://github.com/nourah-alotaibi/gp/blob/main/backend/start.py"
    click CORSChecker "https://github.com/nourah-alotaibi/gp/blob/main/backend/check_env.py"
    click SeverityEngine "https://github.com/nourah-alotaibi/gp/blob/main/backend/severity_engine.py"
    click Preprocessing "https://github.com/nourah-alotaibi/gp/blob/main/backend/extract_treatment_categories.py"
    click Preprocessing "https://github.com/nourah-alotaibi/gp/blob/main/backend/debug_encoders.py"
    click FileIO "https://github.com/nourah-alotaibi/gp/tree/main/backend/uploads/"
    click TrainingData "https://github.com/nourah-alotaibi/gp/blob/main/data/Filtered_Structured_Dataset_TextLabels.xlsx"
    click TemplateData "https://github.com/nourah-alotaibi/gp/blob/main/data/eplipsey_data_template.xlsx"
    click SampleGen "https://github.com/nourah-alotaibi/gp/blob/main/backend/create_sample_data.py"
    click SampleGen "https://github.com/nourah-alotaibi/gp/blob/main/backend/create_sample.py"
    click SampleGen "https://github.com/nourah-alotaibi/gp/blob/main/backend/create_numeric_sample.py"
    click SampleGen "https://github.com/nourah-alotaibi/gp/blob/main/backend/create_exact_sample.py"
    click Tests "https://github.com/nourah-alotaibi/gp/blob/main/backend/test_model.py"
    click Tests "https://github.com/nourah-alotaibi/gp/blob/main/backend/diagnose_issue.py"
    click Tests "https://github.com/nourah-alotaibi/gp/blob/main/backend/test_server.py"
    click Tests "https://github.com/nourah-alotaibi/gp/blob/main/backend/simple_test.py"
    click Docs "https://github.com/nourah-alotaibi/gp/blob/main/backend/HOW_TO_RUN.md"
    click Docs "https://github.com/nourah-alotaibi/gp/blob/main/backend/IMPORTANT_INSTRUCTIONS.md"
    click Docs "https://github.com/nourah-alotaibi/gp/blob/main/backend/README.md"
    click Requirements "https://github.com/nourah-alotaibi/gp/blob/main/backend/requirements.txt"
    click StartupScripts "https://github.com/nourah-alotaibi/gp/blob/main/backend/start_server.sh"
    click StartupScripts "https://github.com/nourah-alotaibi/gp/blob/main/backend/start_server.bat"

    %% Styles
    classDef frontend fill:#BBDEFB,stroke:#2196F3,color:#0D47A1;
    classDef backend fill:#C8E6C9,stroke:#388E3C,color:#1B5E20;
    classDef ml fill:#FFE0B2,stroke:#FB8C00,color:#E65100;
    classDef data fill:#EEEEEE,stroke:#9E9E9E,color:#424242;
    classDef tools fill:#E1BEE7,stroke:#8E24AA,color:#4A148C
```
