# kaxil07/3d-printer-maintenance architecture

> Architecture diagram of the GitHub repository kaxil07/3d-printer-maintenance, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-10-14). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/kaxil07/3d-printer-maintenance
- Repository: https://github.com/kaxil07/3d-printer-maintenance

## Overview

##### Project Type and Purpose
- This is a full-stack application combining a React/TypeScript frontend, a Python/Flask backend that hosts ML models, and a simple data persistence layer. Its goal is to ingest real-time printer data, run predictive analytics, generate alerts, and present dashboards and reports to users.

##### High-Level Component Identification
From the file tree and README, the main components are:
a. External Data Sources
- 3D printers or simulated sensor streams (temperature, vibration, flow, power, environment).
b. Data Ingestion & API Layer
- Flask app (`model/src/api.py`, `api_new.py`, `wsgi.py`)
- Configuration & validation modules (`model/src/config.py`, `maintenance_rules.py`)
c. Data Storage
- Historical CSV files (`model/data/data.csv`) or a time-series/relational DB if added
d. Analytics Engine
- Preprocessor and predictive models (`.pkl` files in `model/models` & `model/src/models`)
- Training pipeline (`train_model.py`, `printer_dataset.py`)
e. Alert & Notification Manager
- Logic in `maintenance_rules.py` + alert endpoints served by the API
f. Cost-Benefit Engine
- Calculation modules invoked by the API and exposed via REST (frontend uses `costBenefitService.ts`)
g. Frontend Application
- Vite + React + TypeScript (`src/`, `public/`)
- Component hierarchy under `src/components/` (Dashboard, MaintenancePanel, PredictionPage, etc.)
- Service layer under `src/services/` for each API endpoint (printer data, maintenance, prediction, costBenefit, printerManagement)
h. CI/CD and Deployment
- GitHub Actions (`.github/workflows/deploy.yml`)
- Environment files (`.env.*`), `DEPLOYMENT.md`

##### Relationships & Data Flows
- Sensors → Flask API (HTTP/WebSocket) → Data validation → Data store
- Flask API → Analytics Engine → Predictions & health scores
- Analytics Engine → Alert Manager → Alert queue/notification service
- Flask API ↔ Frontend (REST endpoints for real-time metrics, alerts, cost-benefit, maintenance tasks)
- Frontend → User interactions (submit new printers, trigger manual predictions)

##### Architectural Patterns & Design Principles
- Layered Architecture:
- Presentation (React UI)
- Application / API (Flask)
- Domain / Analytics (ML models + rules)
- Data (CSV or database)
- Separation of Concerns: each service in the frontend and each module in the backend has a focused responsibility
- Modular ML pipeline: preprocessor, model inference, and training are decoupled
- Extensibility: plugin-style rules in `maintenance_rules.py` and swappable ML models

##### Putting It All Together
- Middle section, left to right:
1. Flask API
2. Data Validation & Storage
3. Analytics Engine (Preprocessor + Model)
4. Alert Manager & Cost-Benefit Engine
- Bottom section: Frontend UI components consuming API

## Diagram (Mermaid)

```mermaid
graph TB
    %% External Systems
    EPrinters["External 3D Printers / Sensor Streams"]:::external

    %% Backend / API Layer
    subgraph "Backend / API Layer"
        FlaskAPI["Flask API"]:::backend
        APINew["API New Entrypoint"]:::backend
        WSGI["WSGI Bootstrap"]:::backend
        Config["Configuration & Validation"]:::backend
        MaintenanceRules["Alert & Rule Definitions"]:::backend
    end

    %% Data Storage
    DataStore["Historical Data Store\n(model/data/data.csv)"]:::data

    %% Analytics Engine
    subgraph "Analytics Engine" 
        Preprocessor["Preprocessor (.pkl)"]:::analytics
        ModelInference["Inference Model (.pkl)"]:::analytics
        subgraph "Training Pipeline"
            DatasetLoader["Dataset Loader"]:::analytics
            TrainModel["Model Training Script"]:::analytics
        end
    end

    %% Alert & Cost Engines
    AlertManager["Alert & Notification Manager"]:::analytics
    CostBenefitEngine["Cost-Benefit Engine"]:::analytics

    %% Frontend UI
    subgraph "Frontend Application"
        Main["src/main.tsx"]:::frontend
        App["src/App.tsx"]:::frontend
        subgraph "Components"
            Dashboard["Dashboard.tsx"]:::frontend
            HealthOverview["HealthOverview.tsx"]:::frontend
            MetricsChart["MetricsChart.tsx"]:::frontend
            PredictionPage["PredictionPage.tsx"]:::frontend
            PredictionForm["PredictionForm.tsx"]:::frontend
            MaintenancePanel["MaintenancePanel.tsx"]:::frontend
            AlertsPanel["AlertsPanel.tsx"]:::frontend
            CostBenefitPanel["CostBenefitPanel.tsx"]:::frontend
            AddPrinterForm["AddPrinterForm.tsx"]:::frontend
            PrinterManagement["PrinterManagement.tsx"]:::frontend
            ErrorBoundary["ErrorBoundary.tsx"]:::frontend
        end
        subgraph "Services"
            PrinterDataService["printerDataService.ts"]:::frontend
            PredictionService["predictionService.ts"]:::frontend
            MaintenanceService["maintenanceService.ts"]:::frontend
            PrinterManagementService["printerManagementService.ts"]:::frontend
            CostBenefitService["costBenefitService.ts"]:::frontend
        end
        subgraph "Types"
            TypePrinter["printer.ts"]:::frontend
            TypePrediction["prediction.ts"]:::frontend
            TypeMaintenance["maintenance.ts"]:::frontend
        end
    end

    %% CI/CD and Deployment
    CICD["CI/CD & Deployment"]:::data
    EnvExample[".env.example"]:::data
    EnvProd[".env.production"]:::data
    DeployDoc["DEPLOYMENT.md"]:::data
    GitHubActions[".github/workflows/deploy.yml"]:::data

    %% Relationships
    EPrinters -->|HTTP/WebSocket| FlaskAPI
    FlaskAPI -->|validates via| Config
    FlaskAPI -->|serves alerts| MaintenanceRules
    FlaskAPI -->|stores data| DataStore
    FlaskAPI -->|invokes| Preprocessor
    Preprocessor -->|processes| ModelInference
    ModelInference -->|results| FlaskAPI
    ModelInference -->|evaluates| AlertManager
    FlaskAPI -->|calculates| CostBenefitEngine
    DataStore -->|provides history| DatasetLoader
    DatasetLoader -->|feeds| TrainModel

    %% Frontend interactions
    App -->|renders| Dashboard
    App -->|routes| PredictionPage
    Dashboard -->|calls| PrinterDataService
    PredictionPage -->|submits| PredictionForm
    PredictionForm -->|calls| PredictionService
    MaintenancePanel -->|uses| MaintenanceService
    AlertsPanel -->|uses| MaintenanceService
    CostBenefitPanel -->|uses| CostBenefitService
    AddPrinterForm -->|calls| PrinterManagementService
    PrinterManagement -->|calls| PrinterManagementService
    ErrorBoundary -->|wraps| App

    FrontendAppClick -->|consumes API| FlaskAPI

    %% CI/CD links
    GitHubActions --> CICD
    EnvExample --> CICD
    EnvProd --> CICD
    DeployDoc --> CICD

    %% Click Events
    click FlaskAPI "https://github.com/kaxil07/3d-printer-maintenance/blob/main/model/src/api.py"
    click APINew "https://github.com/kaxil07/3d-printer-maintenance/blob/main/model/src/api_new.py"
    click WSGI "https://github.com/kaxil07/3d-printer-maintenance/blob/main/model/src/wsgi.py"
    click Config "https://github.com/kaxil07/3d-printer-maintenance/blob/main/model/src/config.py"
    click MaintenanceRules "https://github.com/kaxil07/3d-printer-maintenance/blob/main/model/src/maintenance_rules.py"
    click DataStore "https://github.com/kaxil07/3d-printer-maintenance/blob/main/model/data/data.csv"
    click Preprocessor "https://github.com/kaxil07/3d-printer-maintenance/blob/main/model/models/preprocessor.pkl"
    click ModelInference "https://github.com/kaxil07/3d-printer-maintenance/blob/main/model/models/printer_model.pkl"
    click DatasetLoader "https://github.com/kaxil07/3d-printer-maintenance/blob/main/model/src/printer_dataset.py"
    click TrainModel "https://github.com/kaxil07/3d-printer-maintenance/blob/main/model/src/train_model.py"
    click Main "https://github.com/kaxil07/3d-printer-maintenance/blob/main/src/main.tsx"
    click App "https://github.com/kaxil07/3d-printer-maintenance/blob/main/src/App.tsx"
    click Dashboard "https://github.com/kaxil07/3d-printer-maintenance/blob/main/src/components/Dashboard.tsx"
    click HealthOverview "https://github.com/kaxil07/3d-printer-maintenance/blob/main/src/components/HealthOverview.tsx"
    click MetricsChart "https://github.com/kaxil07/3d-printer-maintenance/blob/main/src/components/MetricsChart.tsx"
    click PredictionPage "https://github.com/kaxil07/3d-printer-maintenance/blob/main/src/components/PredictionPage.tsx"
    click PredictionForm "https://github.com/kaxil07/3d-printer-maintenance/blob/main/src/components/PredictionForm.tsx"
    click MaintenancePanel "https://github.com/kaxil07/3d-printer-maintenance/blob/main/src/components/MaintenancePanel.tsx"
    click AlertsPanel "https://github.com/kaxil07/3d-printer-maintenance/blob/main/src/components/AlertsPanel.tsx"
    click CostBenefitPanel "https://github.com/kaxil07/3d-printer-maintenance/blob/main/src/components/CostBenefitPanel.tsx"
    click AddPrinterForm "https://github.com/kaxil07/3d-printer-maintenance/blob/main/src/components/AddPrinterForm.tsx"
    click PrinterManagement "https://github.com/kaxil07/3d-printer-maintenance/blob/main/src/components/PrinterManagement.tsx"
    click ErrorBoundary "https://github.com/kaxil07/3d-printer-maintenance/blob/main/src/components/ErrorBoundary.tsx"
    click PrinterDataService "https://github.com/kaxil07/3d-printer-maintenance/blob/main/src/services/printerDataService.ts"
    click PredictionService "https://github.com/kaxil07/3d-printer-maintenance/blob/main/src/services/predictionService.ts"
    click MaintenanceService "https://github.com/kaxil07/3d-printer-maintenance/blob/main/src/services/maintenanceService.ts"
    click PrinterManagementService "https://github.com/kaxil07/3d-printer-maintenance/blob/main/src/services/printerManagementService.ts"
    click CostBenefitService "https://github.com/kaxil07/3d-printer-maintenance/blob/main/src/services/costBenefitService.ts"
    click TypePrinter "https://github.com/kaxil07/3d-printer-maintenance/blob/main/src/types/printer.ts"
    click TypePrediction "https://github.com/kaxil07/3d-printer-maintenance/blob/main/src/types/prediction.ts"
    click TypeMaintenance "https://github.com/kaxil07/3d-printer-maintenance/blob/main/src/types/maintenance.ts"
    click GitHubActions "https://github.com/kaxil07/3d-printer-maintenance/blob/main/.github/workflows/deploy.yml"
    click EnvExample "https://github.com/kaxil07/3d-printer-maintenance/blob/main/.env.example"
    click EnvProd "https://github.com/kaxil07/3d-printer-maintenance/blob/main/.env.production"
    click DeployDoc "https://github.com/kaxil07/3d-printer-maintenance/blob/main/DEPLOYMENT.md"

    %% Styles
    classDef frontend fill:#cfe2ff,stroke:#084298,color:#084298
    classDef backend fill:#d1e7dd,stroke:#0f5132,color:#0f5132
    classDef analytics fill:#fff3cd,stroke:#664d03,color:#664d03
    classDef data fill:#e2e3e5,stroke:#41464b,color:#41464b
    classDef external fill:#f8d7da,stroke:#842029,color:#842029
```
