# nguyengiahau0508/tdmu-dispatch-dev architecture

> Architecture diagram of the GitHub repository nguyengiahau0508/tdmu-dispatch-dev, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-15). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/nguyengiahau0508/tdmu-dispatch-dev
- Repository: https://github.com/nguyengiahau0508/tdmu-dispatch-dev

## Overview

##### Project type and purpose
- This is a full-stack web application (“TDmu Document Workflow”) comprising:
- A NestJS GraphQL backend (“apps/backend”) exposing business functionality (auth, approval, dispatch, organizational, file management, user management).
- An Angular frontend SPA (“apps/frontend”) consuming the GraphQL API.
- Infrastructure defined via Docker, Docker Compose, and NGINX.

##### Main components
A. Client Layer
- Browser / Angular SPA
- Apollo Client / HTTP transport
B. Edge / Reverse Proxy
- NGINX (serves static assets, proxies GraphQL requests)
C. API Layer
- NestJS GraphQL Server
– Core Modules (Config, Database, GraphQL‐API)
– Feature Modules (Auth, Approval, Dispatch, Organizational, Files, Users)
– Integrations (Redis Cache, Google Drive, Google OAuth2, Mail)
D. Data Layer
- Primary Database (e.g., PostgreSQL or MySQL)
- Redis (caching / session store)
E. External Services
- Google Drive API
- Google OAuth2
- SMTP/Mail provider

##### Relationships and data flows
- Within NestJS:
- Resolvers invoke Services → Repositories → DB
- Services call Cache service → Redis
- Auth services leverage JWT Strategy → external OAuth2 (Google)
- File uploads/integration services call Google Drive API or Mail Service.
- Responses flow back along the same chain to the client.

##### Architectural patterns and design principles
- Modular Monolith: Distinct NestJS modules encapsulate domain features (each with its own DTOs, entities, services, resolvers).
- Layered Architecture:
- API Layer (GraphQL Resolvers)
- Service Layer (business logic)
- Data Access Layer (TypeORM entities & repositories)
- Configuration via @nestjs/config with schema validation.
- Use of Guards, Filters, Decorators for cross-cutting concerns (auth, roles, exception handling).

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Client Layer
    subgraph "Client Layer" 
        direction LR
        Browser["Browser"]:::ui
        AngularSPA["Angular SPA"]:::ui
        ApolloClient["Apollo Client\n/ HTTP Transport"]:::ui
        Browser -->|loads SPA| AngularSPA
        AngularSPA -->|uses| ApolloClient
    end

    %% Edge / Reverse Proxy
    subgraph "Edge / Reverse Proxy" 
        NGINX["NGINX Proxy"]:::infra
    end

    %% API Layer
    subgraph "API Layer\n(NestJS GraphQL Server)" 
        direction TB
        subgraph "Core Modules"
            ConfigModule["Config Module"]:::app
            DatabaseModule["Database Module"]:::app
            GraphQLModule["GraphQL‐API Module"]:::app
        end
        subgraph "Feature Modules"
            AuthModule["Auth Module"]:::app
            ApprovalModule["Approval Module"]:::app
            DispatchModule["Dispatch Module"]:::app
            OrganizationalModule["Organizational Module"]:::app
            FilesModule["Files Module"]:::app
            UsersModule["Users Module"]:::app
        end
        subgraph "Integrations"
            RedisCache["Redis Cache"]:::app
            GoogleDrive["Google Drive API"]:::app
            GoogleOAuth["Google OAuth2"]:::app
            MailService["Mail Service"]:::app
        end
        ConfigModule -->|provides config| GraphQLModule
        GraphQLModule --> AuthModule
        GraphQLModule --> ApprovalModule
        GraphQLModule --> DispatchModule
        GraphQLModule --> OrganizationalModule
        GraphQLModule --> FilesModule
        GraphQLModule --> UsersModule
        AuthModule -->|uses| GoogleOAuth
        FilesModule -->|uploads| GoogleDrive
        MailService -->|sends mail| MailService
        GraphQLModule -->|caches| RedisCache
        GraphQLModule -->|db ops| DatabaseModule
    end

    %% Data Layer
    subgraph "Data Layer"
        Database["Primary Database"]:::storage
        Redis["Redis Cache"]:::storage
    end

    %% External Services
    subgraph "External Services"
        DriveAPI["Google Drive API"]:::external
        OAuthAPI["Google OAuth2"]:::external
        SMTP["SMTP / Mail Provider"]:::external
    end

    %% Flows
    ApolloClient -->|HTTPS GraphQL| NGINX
    NGINX -->|forwards| GraphQLModule
    AuthModule -->|JWT Strategy| OAuthAPI
    GoogleDrive -->|REST API| DriveAPI
    MailService -->|SMTP| SMTP
    DatabaseModule -->|connects| Database
    RedisCache -->|connects| Redis

    %% Click Events
    click AngularSPA "https://github.com/nguyengiahau0508/tdmu-dispatch-dev/tree/main/apps/frontend/src/app"
    click ApolloClient "https://github.com/nguyengiahau0508/tdmu-dispatch-dev/blob/main/apps/frontend/src/app/core/config/apollo-options.factory.ts"
    click NGINX "https://github.com/nguyengiahau0508/tdmu-dispatch-dev/blob/main/docker/nginx/default.conf"
    click ConfigModule "https://github.com/nguyengiahau0508/tdmu-dispatch-dev/blob/main/apps/backend/src/core/app-config/app-config.module.ts"
    click DatabaseModule "https://github.com/nguyengiahau0508/tdmu-dispatch-dev/blob/main/apps/backend/src/core/database/database.module.ts"
    click GraphQLModule "https://github.com/nguyengiahau0508/tdmu-dispatch-dev/blob/main/apps/backend/src/core/graphql-api/graphql-api.module.ts"
    click AuthModule "https://github.com/nguyengiahau0508/tdmu-dispatch-dev/blob/main/apps/backend/src/auth/auth.module.ts"
    click ApprovalModule "https://github.com/nguyengiahau0508/tdmu-dispatch-dev/blob/main/apps/backend/src/modules/approval/approval.module.ts"
    click DispatchModule "https://github.com/nguyengiahau0508/tdmu-dispatch-dev/blob/main/apps/backend/src/modules/dispatch/dispatch.module.ts"
    click OrganizationalModule "https://github.com/nguyengiahau0508/tdmu-dispatch-dev/blob/main/apps/backend/src/modules/organizational/oraganizational.module.ts"
    click FilesModule "https://github.com/nguyengiahau0508/tdmu-dispatch-dev/blob/main/apps/backend/src/modules/files/files.module.ts"
    click UsersModule "https://github.com/nguyengiahau0508/tdmu-dispatch-dev/blob/main/apps/backend/src/modules/users/users.module.ts"
    click RedisCache "https://github.com/nguyengiahau0508/tdmu-dispatch-dev/blob/main/apps/backend/src/integrations/cache/cache.module.ts"
    click GoogleDrive "https://github.com/nguyengiahau0508/tdmu-dispatch-dev/blob/main/apps/backend/src/integrations/google-drive/google-drive.module.ts"
    click GoogleOAuth "https://github.com/nguyengiahau0508/tdmu-dispatch-dev/blob/main/apps/backend/src/integrations/google-oauth2/google-oauth2.module.ts"
    click MailService "https://github.com/nguyengiahau0508/tdmu-dispatch-dev/blob/main/apps/backend/src/integrations/mail/mail.module.ts"

    %% Styles
    classDef ui fill:#ADD8E6,stroke:#0000FF,color:#000000
    classDef infra fill:#98FB98,stroke:#006400,color:#000000
    classDef app fill:#FFFF99,stroke:#DAA520,color:#000000
    classDef storage fill:#FFA500,stroke:#FF8C00,color:#000000
    classDef external fill:#D8BFD8,stroke:#800080,color:#000000
```
