# hetsonii/smilestamp-attendance_system architecture

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

- Interactive diagram: https://gitdiagram.com/hetsonii/smilestamp-attendance_system
- Repository: https://github.com/hetsonii/smilestamp-attendance_system

## Overview

##### Main Components
a. Frontend UI
- React app (src/, public/)
- Pages/Components: Home, UploadPage, ReviewAttendance, Sidebar, Topbar
b. Backend API
- Flask app (src/Backend/app.py) exposing REST endpoints
c. Liveness‐Detection Pipeline (ML Service)
- Python modules under src/Backend/livenessDetection/ (dataCollection, splitData, train.py, main.py)
- Model files: yolov8n.pt, version2_best.pt, version3_best.pt
d. Data Store
- Attendance data in src/data/attendance.csv & .json
- Students list in src/data/students.js
- Archive folder for historical data
e. Static Assets & Model Storage
- public/classifier folder (trained_knn_model.clf, version3_best.pt)
f. External Dependencies
- YoloV8, PyTorch (for .pt files), scikit‐learn (knn), Flask, React

##### Relationships and Data Flows
- User interacts with React UI → triggers API calls (HTTP POST/GET) to Flask backend
- Frontend “UploadPage” component sends image/video frames to `/detect_liveness` endpoint
- Flask app routes request → invokes livenessDetection/main.py → loads model files → runs inference
- ML pipeline returns liveness verdict + face metadata back to Flask
- Flask persists attendance records to CSV/JSON and returns success payload
- Frontend “ReviewAttendance” component fetches attendance JSON via `/attendance` endpoint
- Data is displayed in UI; users may archive old data, triggering backend to move files under src/data/archive

##### Architectural Patterns
- Separation of concerns:
– Presentation layer (React)
– API layer (Flask)
– ML/inference layer (Python modules)
– Data persistence (File‐based CSV/JSON)
- Modular ML training vs. inference: training code under `runs/…/train`, separate from `main.py` serving model
- Build & deployment via Create React App + Python requirements

##### Detailed Elements
– Component names matching code (UploadPage.js, app.py, dataCollection.py)
– API endpoints (e.g., POST /detect_liveness, GET /attendance)
– Model file names (yolov8n.pt, version2_best.pt)
– Data flow annotations (e.g., “Image frames →❯ LivenessInference →❯ Verdict + FaceID”)
– Optional: note training flow (train.py → runs/detect/train/weights/last.pt) off to one side

##### Putting It All Together
[User Browser]
↓ HTTP
[React Frontend (UploadPage, ReviewAttendance, Sidebar)]
↓ HTTP
[Flask Backend API]
↙︎         ↘︎
ML Service     Data Store
(main.py + model files)  (attendance.csv/.json, archive/)
↑             ↓
External Libraries & Frameworks

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% User
    Browser["User Browser"]:::ext
    
    %% Frontend UI
    subgraph "Frontend UI"
        direction TB
        ReactIndex["Index (src/index.js)"]:::ui
        ReactApp["App (src/App.js)"]:::ui
        Home["Home.js"]:::ui
        UploadPage["UploadPage.js"]:::ui
        ReviewAttendance["ReviewAttendance.js"]:::ui
        Sidebar["Sidebar.js"]:::ui
        Topbar["Topbar.js"]:::ui
    end
    
    %% Backend API
    subgraph "Flask API" 
        direction TB
        AppPy["app.py"]:::api
    end
    
    %% ML Service
    subgraph "ML Service"
        direction TB
        MLMain["main.py"]:::ml
        ExampleMod["example.py"]:::ml
        DataCollect["dataCollection.py"]:::ml
        SplitData["splitData.py"]:::ml
        Train["train.py"]:::ml
        subgraph "Training Runs"
            direction TB
            Args1["runs/detect/train/args.yaml"]:::ml
            Run2["runs/detect/train2/"]:::ml
        end
        YOLO["yolov8n.pt"]:::ml
        V2Model["version2_best.pt"]:::ml
    end
    
    %% Data Store
    subgraph "Data Store"
        direction TB
        AttCSV["attendance.csv"]:::data
        AttJSON["attendance.json"]:::data
        Students["students.js"]:::data
        Archive["archive/"]:::data
    end
    
    %% Static Assets
    subgraph "Static Assets & Models"
        direction TB
        KNNModel["trained_knn_model.clf"]:::data
        V3Model["version3_best.pt"]:::data
    end
    
    %% External Libraries
    subgraph "External Dependencies"
        direction TB
        YoloLib["YoloV8"]:::ext
        Torch["PyTorch"]:::ext
        SKLearn["scikit-learn"]:::ext
        FlaskLib["Flask"]:::ext
        ReactLib["React"]:::ext
    end
    
    %% Connections
    Browser --> ReactIndex
    ReactIndex --> ReactApp
    ReactApp --> Home
    ReactApp --> UploadPage
    ReactApp --> ReviewAttendance
    ReactApp --> Sidebar
    ReactApp --> Topbar
    
    UploadPage -->|"POST /detect_liveness"| AppPy
    ReviewAttendance -->|"GET /attendance"| AppPy
    
    AppPy -->|"invoke inference"| MLMain
    MLMain -->|"loads model"| YOLO
    MLMain -->|"loads model"| V2Model
    MLMain --> AppPy
    AppPy -->|"store record"| AttCSV
    AppPy --> AttJSON
    AppPy -->|"archive old"| Archive
    
    MLMain --> ExampleMod
    MLMain --> DataCollect
    MLMain --> SplitData
    MLMain --> Train
    Train --> Args1
    Train --> Run2
    
    AppPy --> Students
    
    %% Static assets served by frontend
    ReactApp --> KNNModel
    ReactApp --> V3Model
    
    %% External libs usage
    MLMain --> YoloLib
    MLMain --> Torch
    MLMain --> SKLearn
    AppPy --> FlaskLib
    ReactApp --> ReactLib
    
    %% Click events
    click ReactIndex "https://github.com/hetsonii/smilestamp-attendance_system/blob/main/src/index.js"
    click ReactApp "https://github.com/hetsonii/smilestamp-attendance_system/blob/main/src/App.js"
    click Home "https://github.com/hetsonii/smilestamp-attendance_system/blob/main/src/components/Home.js"
    click UploadPage "https://github.com/hetsonii/smilestamp-attendance_system/blob/main/src/components/UploadPage.js"
    click ReviewAttendance "https://github.com/hetsonii/smilestamp-attendance_system/blob/main/src/components/Reviewattendance.js"
    click Sidebar "https://github.com/hetsonii/smilestamp-attendance_system/blob/main/src/components/Sidebar.js"
    click Topbar "https://github.com/hetsonii/smilestamp-attendance_system/blob/main/src/components/Topbar.js"
    click AppPy "https://github.com/hetsonii/smilestamp-attendance_system/blob/main/src/Backend/app.py"
    click MLMain "https://github.com/hetsonii/smilestamp-attendance_system/blob/main/src/Backend/livenessDetection/main.py"
    click ExampleMod "https://github.com/hetsonii/smilestamp-attendance_system/blob/main/src/Backend/livenessDetection/example.py"
    click DataCollect "https://github.com/hetsonii/smilestamp-attendance_system/blob/main/src/Backend/livenessDetection/dataCollection.py"
    click SplitData "https://github.com/hetsonii/smilestamp-attendance_system/blob/main/src/Backend/livenessDetection/splitData.py"
    click Train "https://github.com/hetsonii/smilestamp-attendance_system/blob/main/src/Backend/livenessDetection/train.py"
    click YOLO "https://github.com/hetsonii/smilestamp-attendance_system/blob/main/src/Backend/livenessDetection/yolov8n.pt"
    click V2Model "https://github.com/hetsonii/smilestamp-attendance_system/blob/main/src/Backend/livenessDetection/version2_best.pt"
    click Args1 "https://github.com/hetsonii/smilestamp-attendance_system/blob/main/src/Backend/livenessDetection/runs/detect/train/args.yaml"
    click Run2 "https://github.com/hetsonii/smilestamp-attendance_system/tree/main/src/Backend/livenessDetection/runs/detect/train2/"
    click AttCSV "https://github.com/hetsonii/smilestamp-attendance_system/blob/main/src/data/attendance.csv"
    click AttJSON "https://github.com/hetsonii/smilestamp-attendance_system/blob/main/src/data/attendance.json"
    click Students "https://github.com/hetsonii/smilestamp-attendance_system/blob/main/src/data/students.js"
    click Archive "https://github.com/hetsonii/smilestamp-attendance_system/tree/main/src/data/archive/"
    click KNNModel "https://github.com/hetsonii/smilestamp-attendance_system/blob/main/public/classifier/trained_knn_model.clf"
    click V3Model "https://github.com/hetsonii/smilestamp-attendance_system/blob/main/public/classifier/version3_best.pt"
    
    %% Styling
    classDef ui fill:#D0E8FF,stroke:#1E90FF,color:#000;
    classDef api fill:#DFFFD0,stroke:#32CD32,color:#000;
    classDef ml fill:#FFE4B5,stroke:#FF8C00,color:#000;
    classDef data fill:#F0F0F0,stroke:#A9A9A9,color:#000;
    classDef ext fill:#E6E6FA,stroke:#9370DB,color:#000;
```
