# rienierborong/20241_t172_buksu-fitness-gym-management-system architecture

> Architecture diagram of the GitHub repository rienierborong/20241_t172_buksu-fitness-gym-management-system, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-12). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/rienierborong/20241_t172_buksu-fitness-gym-management-system
- Repository: https://github.com/rienierborong/20241_t172_buksu-fitness-gym-management-system

## Overview

##### Project type and purpose
- This is a full-stack web application (“BukSU Fitness Gym – Digital Logging System”) consisting of:
- A React single-page application (client/)
- A Node.js/Express REST API server (server/)
- A database (via server/db/db.js, e.g., MongoDB with Mongoose models)
- External services (Gmail SMTP for emails, biometric fingerprint scanner hardware)

##### File structure to derive the architecture
- client/
- src/components, pages, assets → React components and views
- build/ and public/ → packaged static assets, fonts, CSS
- protected routes (ProtectedRoute.js) and front-end routing (React Router)
- server/
- routes/ → Express route definitions (auth.js, captchaRoutes.js, history.js, reportgen.js, etc.)
- controllers/ → business logic for captcha, email, report generation
- models/ → Mongoose models (User, LoginHistory)
- utils/ → middleware (authMiddleware), tokenService, cleanup jobs
- config/passport.js → Passport.js local or JWT configuration
- db/db.js → database connection setup

##### README for additional insights
- Uses biometric fingerprint scanning to log entries
- Limits three gym visits per week, auto-reset via a scheduled cleanup utility
- Sends emails (Gmail SMTP) for sign-up, reports, notifications
- No .env included; credentials supplied externally

##### Main components & their interactions
a. Frontend (React SPA)
- Users log in/sign up, scan fingerprint, view history, leaderboards, admin pages
- Routes protected by ProtectedRoute → checks valid JWT or session cookie
b. Backend API (Node/Express)
- Exposes REST endpoints for authentication, fingerprint data (captcha), history, reports, misc
- Uses Passport.js + tokenService for JWT/session issuance
- Controllers implement logic: validate fingerprint input, enforce visit limits, generate reports
- cleanup.js runs weekly job to reset visit counts
c. Database
- Stores User documents and LoginHistory entries
d. External services
- Biometric scanner hardware → frontend sends scanned data (via driver or USB interface) to backend /captchaRoutes
- Gmail SMTP (emailService route) → sends confirmation and report emails

##### Architectural patterns & design principles
- MVC-style backend separation (routes → controllers → models)
- RESTful API layer between front and back
- Stateless authentication with JWT (or sessions) via Passport.js
- Scheduled background job (cleanup) for weekly limit resets
- Component-based front-end with protected routes

- Each component clearly labeled (e.g., “React SPA,” “Express API,” “MongoDB”)
- Notes on authentication flow and scheduled cleanup

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% User
    Browser((User Browser)):::external

    %% Frontend
    subgraph "Frontend (React SPA)"
        direction TB
        ReactIndex["Index Entry (client/src/index.js)"]:::frontend
        ReactApp["App Component (client/src/App.js)"]:::frontend
        ProtectedRoute["ProtectedRoute (client/src/components/ProtectedRoute.js)"]:::frontend
        Pages["Pages (client/src/pages/)"]:::frontend
        Assets["Assets & Styles (client/src/assets/, client/src/styles/)"]:::frontend
        Build["Production Build (client/build/, client/public/)"]:::frontend
    end

    %% Backend
    subgraph "Backend (Node.js/Express API)"
        direction TB
        ServerEntry["Server Entry (server/server.js)"]:::backend
        PassportConfig["Passport Config (server/config/passport.js)"]:::backend
        subgraph "Routes"
            direction TB
            AuthRoutes["Auth Routes (server/routes/auth.js)"]:::backend
            CaptchaRoutes["Captcha Routes (server/routes/captchaRoutes.js)"]:::backend
            EmailRoutes["Email Service Routes (server/routes/emailService.js)"]:::backend
            HistoryRoutes["History Routes (server/routes/history.js)"]:::backend
            ReportRoutes["Report Gen Routes (server/routes/reportgen.js)"]:::backend
            MiscRoutes["Misc Routes (server/routes/misc.js)"]:::backend
        end
        subgraph "Controllers"
            direction TB
            CaptchaController["Captcha Controller (server/controllers/captchaController.js)"]:::backend
        end
        subgraph "Utils"
            direction TB
            AuthMiddleware["Auth Middleware (server/utils/authMiddleware.js)"]:::backend
            TokenService["Token Service (server/utils/tokenService.js)"]:::backend
            CleanupJob["Cleanup Job (server/utils/cleanup.js)"]:::backend
        end
        DBSetup["DB Setup (server/db/db.js)"]:::backend
        subgraph "Models"
            direction TB
            UserModel["User Model (server/models/User.js)"]:::backend
            HistoryModel["LoginHistory Model (server/models/LoginHistory.js)"]:::backend
        end
    end

    %% Data Stores & External
    Database[(MongoDB Database)]:::database
    Gmail((Gmail SMTP)):::external
    Scanner((Biometric Scanner)):::external

    %% Connections
    Browser -->|uses UI| ReactIndex
    ReactIndex --> ReactApp
    ReactApp --> ProtectedRoute
    ProtectedRoute --> Pages
    ReactApp --> Assets
    ReactApp --> Build
    ReactApp -->|API Requests| ServerEntry

    ServerEntry --> PassportConfig
    ServerEntry --> AuthRoutes
    ServerEntry --> CaptchaRoutes
    ServerEntry --> EmailRoutes
    ServerEntry --> HistoryRoutes
    ServerEntry --> ReportRoutes
    ServerEntry --> MiscRoutes
    AuthRoutes --> CaptchaController
    CaptchaRoutes --> CaptchaController
    ServerEntry --> DBSetup
    DBSetup --> UserModel
    DBSetup --> HistoryModel
    ServerEntry --> AuthMiddleware
    ServerEntry --> TokenService
    CleanupJob --> DBSetup

    ServerEntry -->|read/write| Database
    ServerEntry -->|send email| Gmail
    CaptchaRoutes -->|ingest fingerprint| Scanner

    %% Click Events
    click ReactIndex "https://github.com/rienierborong/20241_t172_buksu-fitness-gym-management-system/blob/main/client/src/index.js"
    click ReactApp "https://github.com/rienierborong/20241_t172_buksu-fitness-gym-management-system/blob/main/client/src/App.js"
    click ProtectedRoute "https://github.com/rienierborong/20241_t172_buksu-fitness-gym-management-system/blob/main/client/src/components/ProtectedRoute.js"
    click Pages "https://github.com/rienierborong/20241_t172_buksu-fitness-gym-management-system/tree/main/client/src/pages/"
    click Assets "https://github.com/rienierborong/20241_t172_buksu-fitness-gym-management-system/tree/main/client/src/assets/"
    click Build "https://github.com/rienierborong/20241_t172_buksu-fitness-gym-management-system/tree/main/client/build/"
    click ServerEntry "https://github.com/rienierborong/20241_t172_buksu-fitness-gym-management-system/blob/main/server/server.js"
    click PassportConfig "https://github.com/rienierborong/20241_t172_buksu-fitness-gym-management-system/blob/main/server/config/passport.js"
    click AuthRoutes "https://github.com/rienierborong/20241_t172_buksu-fitness-gym-management-system/blob/main/server/routes/auth.js"
    click CaptchaRoutes "https://github.com/rienierborong/20241_t172_buksu-fitness-gym-management-system/blob/main/server/routes/captchaRoutes.js"
    click EmailRoutes "https://github.com/rienierborong/20241_t172_buksu-fitness-gym-management-system/blob/main/server/routes/emailService.js"
    click HistoryRoutes "https://github.com/rienierborong/20241_t172_buksu-fitness-gym-management-system/blob/main/server/routes/history.js"
    click ReportRoutes "https://github.com/rienierborong/20241_t172_buksu-fitness-gym-management-system/blob/main/server/routes/reportgen.js"
    click MiscRoutes "https://github.com/rienierborong/20241_t172_buksu-fitness-gym-management-system/blob/main/server/routes/misc.js"
    click CaptchaController "https://github.com/rienierborong/20241_t172_buksu-fitness-gym-management-system/blob/main/server/controllers/captchaController.js"
    click DBSetup "https://github.com/rienierborong/20241_t172_buksu-fitness-gym-management-system/blob/main/server/db/db.js"
    click UserModel "https://github.com/rienierborong/20241_t172_buksu-fitness-gym-management-system/blob/main/server/models/User.js"
    click HistoryModel "https://github.com/rienierborong/20241_t172_buksu-fitness-gym-management-system/blob/main/server/models/LoginHistory.js"
    click AuthMiddleware "https://github.com/rienierborong/20241_t172_buksu-fitness-gym-management-system/blob/main/server/utils/authMiddleware.js"
    click TokenService "https://github.com/rienierborong/20241_t172_buksu-fitness-gym-management-system/blob/main/server/utils/tokenService.js"
    click CleanupJob "https://github.com/rienierborong/20241_t172_buksu-fitness-gym-management-system/blob/main/server/utils/cleanup.js"

    %% Styles
    classDef frontend fill:#dae8fc,stroke:#6c8ebf,color:#073763
    classDef backend fill:#d5e8d4,stroke:#82b366,color:#274e13
    classDef database fill:#fff2cc,stroke:#d6b656,color:#7f6000
    classDef external fill:#f8cecc,stroke:#b85450,color:#721c24
```
