# darshilpadmani/invoice architecture

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

- Interactive diagram: https://gitdiagram.com/darshilpadmani/invoice
- Repository: https://github.com/darshilpadmani/invoice

## Overview

##### Project’s Nature
- Full-stack web application for invoice/quote/customer management
- Frontend: React.js SPA with Ant Design
- Backend: Node.js/Express REST API
- Database: MongoDB (via Mongoose)
- Auxiliary services: PDF generation (Pug templates), email delivery, file-storage

##### Lay Out the Main High-Level Components
A. Client Browser (React SPA)
– UI Components & Presentation (frontend/src/components, modules, pages)
– State Management: React Context + Redux store
– Routing: React Router
– HTTP Client / Auth Service (frontend/src/auth + request layer)
B. API Server (Express.js)
– HTTP Server entrypoint (backend/src/app.js → server.js)
– Routers: appRoutes (business APIs) & coreRoutes (auth, public, downloads)
– Controllers:
- appControllers: invoice, quote, payment, client, taxes
- coreControllers: adminAuth, settings, setup
- pdfController for on-the-fly PDF generation
– Middlewares: auth, CRUD scaffolding, file-upload, settings/inventory injection, error handling
– Handlers: downloadHandler, errorHandlers
C. Database Layer (MongoDB)
– Collections & Mongoose Models under backend/src/models (appModels & coreModels)
D. File Storage (local FS)
– public/uploads via uploadMiddleware
E. External Services
– Email Service (SendEmailTemplate + SMTP or third-party)

##### Relationships & Data Flows
1. User interacts with React SPA → HTTP(S) requests to Express API
2. Express handles request via Router → Middleware chain → Controller
3. Controller invokes Mongoose Model → MongoDB CRUD
4. For PDF: Controller → pdfController uses Pug templates → returns binary/pdf
5. For emails: Controller → SendEmailTemplate → SMTP/third-party
6. File uploads: Controller + uploadMiddleware → saves to local disk → public folder
7. Responses return JSON or file stream back to SPA

##### Architectural Patterns & Technologies
- MVC-style on backend: Routers → Controllers → Models
- Layered Middlewares (auth, validation, settings injection)
- Component-based on frontend with container/presentational split
- State orchestration via React Context + Redux
- Service layer for HTTP, auth, error handling, success management
- Build tools: Vite/Rollup for frontend, nodemon/pm2 for backend

## Diagram (Mermaid)

```mermaid
graph TB
    %% Frontend Layer
    subgraph "Client Browser (React SPA)"
        direction TB
        UI["UI Components & Presentation"]:::frontend
        Pages["Pages/Modules"]:::frontend
        Context["State Management (React Context)"]:::frontend
        Redux["State Management (Redux)"]:::frontend
        Routing["Routing (React Router)"]:::frontend
        HTTP["HTTP Client / Auth Service"]:::frontend
    end

    %% API Server Layer
    subgraph "API Server (Express.js)"
        direction TB
        ServerEntry["HTTP Server Entrypoint"]:::backend

        subgraph "Routers"
            direction TB
            AppRoutes["Business API Routers"]:::backend
            CoreRoutes["Core/Auth/Public/Download Routers"]:::backend
        end

        subgraph "Controllers"
            direction TB
            AppControllers["App Controllers"]:::backend
            CoreControllers["Core Controllers"]:::backend
            PDFController["PDF Generation Controller"]:::backend
        end

        subgraph "Middleware Controllers"
            direction TB
            MiddlewareControllers["Auth/CRUD Scaffolding Controllers"]:::backend
        end

        subgraph "Custom Middlewares"
            direction TB
            CustomMiddlewares["Inventory/Settings/Upload Middlewares"]:::backend
        end

        subgraph "Handlers"
            direction TB
            DownloadHandler["Download Handler"]:::backend
            ErrorHandlers["Error Handlers"]:::backend
        end
    end

    %% Database Layer
    subgraph "Database (MongoDB)"
        direction TB
        AppModels["Mongoose App Models"]:::db
        CoreModels["Mongoose Core Models"]:::db
    end

    %% File Storage Layer
    FileStorage["Public Uploads (Local FS)"]:::storage

    %% External Services Layer
    EmailService["Email Service (SMTP/Third-party)"]:::external

    %% Data Flows
    UI -->|"HTTP/REST (JSON)"| ServerEntry
    Pages --> ServerEntry
    Context --> ServerEntry
    Redux --> ServerEntry
    Routing --> ServerEntry
    HTTP --> ServerEntry

    ServerEntry -->|routes to| AppRoutes
    ServerEntry -->|routes to| CoreRoutes

    AppRoutes -->|uses| AppControllers
    CoreRoutes -->|uses| CoreControllers

    AppControllers -->|CRUD via| AppModels
    CoreControllers -->|CRUD via| CoreModels

    AppControllers -->|generate PDF| PDFController
    PDFController -->|templates| PDFTemplates

    AppControllers -->|invoke| MiddlewareControllers
    CoreControllers -->|invoke| MiddlewareControllers

    AppControllers -->|use| CustomMiddlewares
    CoreControllers -->|use| CustomMiddlewares

    AppControllers -->|download PDF| DownloadHandler
    ServerEntry -->|error flow| ErrorHandlers

    ServerEntry -->|"TCP/Mongo"| AppModels
    ServerEntry -->|"TCP/Mongo"| CoreModels

    ServerEntry -->|"FS Read/Write (multipart/form-data)"| FileStorage
    AppControllers -->|"FS Read/Write"| FileStorage

    AppControllers -->|"SMTP/API"| EmailService
    CoreControllers -->|"SMTP/API"| EmailService

    %% PDF Templates (internal)
    subgraph "PDF Templates (Pug)"
        direction TB
        PDFTemplates["Invoice/Offer/Payment/Quote Templates"]:::backend
    end

    PDFController --> PDFTemplates

    %% Click Events
    click UI "https://github.com/darshilpadmani/invoice/tree/main/frontend/src/components"
    click Pages "https://github.com/darshilpadmani/invoice/tree/main/frontend/src/pages"
    click Pages "https://github.com/darshilpadmani/invoice/tree/main/frontend/src/modules"
    click Context "https://github.com/darshilpadmani/invoice/tree/main/frontend/src/context"
    click Redux "https://github.com/darshilpadmani/invoice/tree/main/frontend/src/redux"
    click Routing "https://github.com/darshilpadmani/invoice/tree/main/frontend/src/router"
    click HTTP "https://github.com/darshilpadmani/invoice/tree/main/frontend/src/auth"
    click HTTP "https://github.com/darshilpadmani/invoice/tree/main/frontend/src/request"
    click ServerEntry "https://github.com/darshilpadmani/invoice/blob/main/backend/src/app.js"
    click ServerEntry "https://github.com/darshilpadmani/invoice/blob/main/backend/src/server.js"
    click AppRoutes "https://github.com/darshilpadmani/invoice/blob/main/backend/src/routes/appRoutes/appApi.js"
    click CoreRoutes "https://github.com/darshilpadmani/invoice/blob/main/backend/src/routes/coreRoutes/coreApi.js"
    click CoreRoutes "https://github.com/darshilpadmani/invoice/blob/main/backend/src/routes/coreRoutes/coreAuth.js"
    click CoreRoutes "https://github.com/darshilpadmani/invoice/blob/main/backend/src/routes/coreRoutes/coreDownloadRouter.js"
    click CoreRoutes "https://github.com/darshilpadmani/invoice/blob/main/backend/src/routes/coreRoutes/corePublicRouter.js"
    click AppControllers "https://github.com/darshilpadmani/invoice/tree/main/backend/src/controllers/appControllers"
    click CoreControllers "https://github.com/darshilpadmani/invoice/tree/main/backend/src/controllers/coreControllers"
    click PDFController "https://github.com/darshilpadmani/invoice/blob/main/backend/src/controllers/pdfController/index.js"
    click MiddlewareControllers "https://github.com/darshilpadmani/invoice/tree/main/backend/src/controllers/middlewaresControllers"
    click CustomMiddlewares "https://github.com/darshilpadmani/invoice/tree/main/backend/src/middlewares"
    click DownloadHandler "https://github.com/darshilpadmani/invoice/blob/main/backend/src/handlers/downloadHandler/downloadPdf.js"
    click ErrorHandlers "https://github.com/darshilpadmani/invoice/blob/main/backend/src/handlers/errorHandlers.js"
    click AppModels "https://github.com/darshilpadmani/invoice/tree/main/backend/src/models/appModels"
    click CoreModels "https://github.com/darshilpadmani/invoice/tree/main/backend/src/models/coreModels"
    click FileStorage "https://github.com/darshilpadmani/invoice/tree/main/backend/src/public/uploads"
    click PDFTemplates "https://github.com/darshilpadmani/invoice/blob/main/backend/src/pdf/Invoice.pug"
    click EmailService "https://github.com/darshilpadmani/invoice/blob/main/backend/src/emailTemplate/SendEmailTemplate.js"
    click EmailService "https://github.com/darshilpadmani/invoice/blob/main/backend/src/emailTemplate/emailVerfication.js"

    %% Styles
    classDef frontend fill:#cce5ff,stroke:#004085,color:#004085
    classDef backend fill:#d4edda,stroke:#155724,color:#155724
    classDef db fill:#fff3cd,stroke:#856404,color:#856404
    classDef storage fill:#e2e3e5,stroke:#6c757d,color:#6c757d
    classDef external fill:#f5c6cb,stroke:#721c24,color:#721c24
```
