# superfier/fibertrack architecture

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

- Interactive diagram: https://gitdiagram.com/superfier/fibertrack
- Repository: https://github.com/superfier/fibertrack

## Overview

##### Project type and purpose
- This is a full-stack web application (“FIBERTRACK”) comprising:
- A React-based single-page frontend (folder: optifiber) built with Vite.
- A Node.js/Express REST API backend (folder: OptifiberAPI) using MongoDB.
- Purpose: Manage fiber-optic clients—authentication, client profiles, documents, notes, payments, tickets, service packages, plus map integration and email recovery.

##### File structure
- Top-level separation:
- optifiber/ → Frontend SPA
- OptifiberAPI/ → Backend API
- Backend structure follows MVC-ish:
- src/controllers → request handlers per resource (auth.client.document…)
- src/middlewares → route definitions and access control
- src/models → Mongoose schemas (clients, tickets, payments…)
- src/libs → cross-cutting utilities (CORS, multer for file uploads, nodemailer)
- src/db_conn.js → MongoDB connection
- src/server.js → Express app bootstrap
- storage/img → persisted client-uploaded files
- src/templates → HTML email and index templates
- Frontend structure is component-driven:
- src/components/auth, clients, fragments, home, payments, profile, services packages, tickets
- Custom hooks (apiRequest), maps integration, CSS modules for scoping.
- vite.config.js + public assets.

##### Insights from README
- Environment variables control API base URL, Google Maps API key, MongoDB URI, JWT secret, email password.
- Two processes run concurrently: `npm run dev` in optifiber (Vite server) and in optifiberAPI (nodemon/Express).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Presentation Layer
    subgraph "User Layer"
        Browser["User's Web Browser"]:::external
    end

    %% Frontend Layer
    subgraph "Frontend Layer"
        direction TB
        Vite["Vite Dev Server"]:::frontend
        ReactApp["React SPA"]:::frontend
        subgraph "Components"
            direction TB
            AuthComp["Auth Components"]:::frontend
            ClientsComp["Client Management Components"]:::frontend
            DocsComp["Client Documents Components"]:::frontend
            NotesComp["Client Notes Components"]:::frontend
            PaymentComp["Client Payments Components"]:::frontend
            TicketsComp["Client Tickets Components"]:::frontend
            PaymentsUI["Independent Payments UI"]:::frontend
            TicketsUI["Tickets UI"]:::frontend
            ServicesUI["Service Packages UI"]:::frontend
            Fragments["Reusable Fragments"]:::frontend
            MapsFrag["Maps Integration"]:::frontend
            Hook["API Data‐Fetching Hook"]:::frontend
        end
        Assets["Public Assets & Styles"]:::frontend
        ViteConfig["vite.config.js"]:::frontend
    end

    %% API Layer
    subgraph "Backend Layer"
        direction TB
        Express["Express API Server"]:::backend
        middlewares["Route Definitions (Middlewares)"]:::backend
        controllers["Controllers (Business Logic)"]:::backend
        libs["Cross-cutting Utilities"]:::backend
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        Models["Mongoose Models"]:::database
        DB["MongoDB Atlas"]:::database
        Storage["File Storage"]:::database
        Templates["Email & HTML Templates"]:::backend
    end

    %% External Services
    subgraph "External Services"
        direction TB
        GoogleMaps["Google Maps API"]:::external
        SMTP["Email SMTP Service"]:::external
    end

    %% Connections
    Browser -->|HTTP Requests| Vite
    Vite -->|Serves SPA| ReactApp
    ReactApp -->|REST API JSON| Express
    ReactApp -->|Loads Assets| Assets
    ReactApp -->|Uses Maps API| GoogleMaps
    ReactApp -->|Sends Emails via| SMTP
    Express -->|Uses Routes| middlewares
    middlewares -->|Call Controllers| controllers
    controllers -->|CRUD Operations| Models
    controllers -->|Send Recovery Email| Templates
    controllers -->|Handle File Upload| Storage
    Models -->|Persist Data| DB
    Storage ---|Stores Files| DB

    %% Click Events Frontend
    click Vite "https://github.com/superfier/fibertrack/blob/main/optifiber/vite.config.js"
    click ReactApp "https://github.com/superfier/fibertrack/blob/main/optifiber/src/main.jsx"
    click AuthComp "https://github.com/superfier/fibertrack/tree/main/optifiber/src/components/auth/"
    click ClientsComp "https://github.com/superfier/fibertrack/tree/main/optifiber/src/components/clients/"
    click DocsComp "https://github.com/superfier/fibertrack/tree/main/optifiber/src/components/clients/documents/"
    click NotesComp "https://github.com/superfier/fibertrack/tree/main/optifiber/src/components/clients/notes/"
    click PaymentComp "https://github.com/superfier/fibertrack/tree/main/optifiber/src/components/clients/payment/"
    click TicketsComp "https://github.com/superfier/fibertrack/tree/main/optifiber/src/components/clients/tickets/"
    click PaymentsUI "https://github.com/superfier/fibertrack/tree/main/optifiber/src/components/payments/"
    click TicketsUI "https://github.com/superfier/fibertrack/tree/main/optifiber/src/components/tickets/"
    click ServicesUI "https://github.com/superfier/fibertrack/tree/main/optifiber/src/components/services packages/"
    click Fragments "https://github.com/superfier/fibertrack/tree/main/optifiber/src/components/fragments/"
    click MapsFrag "https://github.com/superfier/fibertrack/blob/main/optifiber/src/components/fragments/maps/Map.fragment.jsx"
    click Hook "https://github.com/superfier/fibertrack/blob/main/optifiber/src/components/hooks/apiRequest.jsx"
    click Assets "https://github.com/superfier/fibertrack/tree/main/optifiber/public/"
    click Assets "https://github.com/superfier/fibertrack/tree/main/optifiber/src/public/"

    %% Click Events Backend
    click Express "https://github.com/superfier/fibertrack/blob/main/OptifiberAPI/src/server.js"
    click DB "https://github.com/superfier/fibertrack/blob/main/OptifiberAPI/src/db_conn.js"
    click controllers "https://github.com/superfier/fibertrack/blob/main/OptifiberAPI/src/controller/auth.controller.js"
    click controllers "https://github.com/superfier/fibertrack/blob/main/OptifiberAPI/src/controller/client.controller.js"
    click controllers "https://github.com/superfier/fibertrack/blob/main/OptifiberAPI/src/controller/document.controller.js"
    click controllers "https://github.com/superfier/fibertrack/blob/main/OptifiberAPI/src/controller/notes.controller.js"
    click controllers "https://github.com/superfier/fibertrack/blob/main/OptifiberAPI/src/controller/payment.controller.js"
    click controllers "https://github.com/superfier/fibertrack/blob/main/OptifiberAPI/src/controller/profile.controller.js"
    click controllers "https://github.com/superfier/fibertrack/blob/main/OptifiberAPI/src/controller/servicesPackage.controller.js"
    click controllers "https://github.com/superfier/fibertrack/blob/main/OptifiberAPI/src/controller/ticket.controller.js"
    click middlewares "https://github.com/superfier/fibertrack/blob/main/OptifiberAPI/src/middlewares/auth.routes.js"
    click middlewares "https://github.com/superfier/fibertrack/blob/main/OptifiberAPI/src/middlewares/client.routes.js"
    click middlewares "https://github.com/superfier/fibertrack/blob/main/OptifiberAPI/src/middlewares/document.routes.js"
    click middlewares "https://github.com/superfier/fibertrack/blob/main/OptifiberAPI/src/middlewares/notes.routes.js"
    click middlewares "https://github.com/superfier/fibertrack/blob/main/OptifiberAPI/src/middlewares/payment.routes.js"
    click middlewares "https://github.com/superfier/fibertrack/blob/main/OptifiberAPI/src/middlewares/profile.routes.js"
    click middlewares "https://github.com/superfier/fibertrack/blob/main/OptifiberAPI/src/middlewares/servicesPackage.routes.js"
    click middlewares "https://github.com/superfier/fibertrack/blob/main/OptifiberAPI/src/middlewares/ticket.routes.js"
    click Models "https://github.com/superfier/fibertrack/blob/main/OptifiberAPI/src/models/adminSchema.js"
    click Models "https://github.com/superfier/fibertrack/blob/main/OptifiberAPI/src/models/clientSchema.js"
    click Models "https://github.com/superfier/fibertrack/blob/main/OptifiberAPI/src/models/documentSchema.js"
    click Models "https://github.com/superfier/fibertrack/blob/main/OptifiberAPI/src/models/notesSchema.js"
    click Models "https://github.com/superfier/fibertrack/blob/main/OptifiberAPI/src/models/paymentsSchema.js"
    click Models "https://github.com/superfier/fibertrack/blob/main/OptifiberAPI/src/models/resetCodeSchema.js"
    click Models "https://github.com/superfier/fibertrack/blob/main/OptifiberAPI/src/models/servicesSchema.js"
    click Models "https://github.com/superfier/fibertrack/blob/main/OptifiberAPI/src/models/ticketsSchema.js"
    click libs "https://github.com/superfier/fibertrack/blob/main/OptifiberAPI/src/libs/cors.js"
    click libs "https://github.com/superfier/fibertrack/blob/main/OptifiberAPI/src/libs/multer.js"
    click libs "https://github.com/superfier/fibertrack/blob/main/OptifiberAPI/src/libs/nodemailer.js"
    click Templates "https://github.com/superfier/fibertrack/blob/main/OptifiberAPI/src/templates/emailRecovery.html"
    click Storage "https://github.com/superfier/fibertrack/tree/main/OptifiberAPI/storage/img/"

    %% Styles
    classDef frontend fill:#cfe2f3,stroke:#4a90e2,stroke-width:2px
    classDef backend fill:#d4edda,stroke:#28a745,stroke-width:2px
    classDef database fill:#fff3cd,stroke:#ffca28,stroke-width:2px
    classDef external fill:none,stroke:#6c757d,stroke-dasharray: 5 5
    class Browser,GoogleMaps,SMTP external
    class Vite,ReactApp,AuthComp,ClientsComp,DocsComp,NotesComp,PaymentComp,TicketsComp,PaymentsUI,TicketsUI,ServicesUI,Fragments,MapsFrag,Hook,Assets,ViteConfig frontend
    class Express,middlewares,controllers,libs,Templates backend
    class Models,DB,Storage database
```
