# nambui98/mtd-tax architecture

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

- Interactive diagram: https://gitdiagram.com/nambui98/mtd-tax
- Repository: https://github.com/nambui98/mtd-tax

## Overview

##### Project type and purpose
- This is a full-stack monorepo for a SaaS-style application.
- apps/web: Next.js (App Router) frontend with Tailwind and shadcn/UI components.
- apps/api: NestJS backend exposing REST endpoints, modules for auth, users, clients, documents, HMRC integration, uploads (S3), mailing, roles.
- packages/ui: shared React UI library.
- packages/database: Drizzle ORM setup, migrations and seeds.
- Monorepo tooling: pnpm workspaces, Turbo, shared ESLint/TS configs.

##### File structure
- Top-level “apps” directory splits frontend vs. backend.
- “packages” holds shared libraries (UI, DB migration/ORM, config presets).
- API uses NestJS’s module structure (auth, users, clients, etc.).
- Web uses Next.js App folder, NextAuth route, shared “components”, “services/api.ts” client.
- Config files at root (docker-compose.yml, turbo.json, pnpm-workspace.yaml) define dev and deploy orchestration.
- DB migrations in packages/database/drizzle, Drizzle CLI for schema management.

##### README for additional insights
- Confirms use of shadcn components in apps/web via packages/ui.
- Tailwind is configured for the UI package.
- Drizzle CLI commands available for generating and running migrations.

##### Detail
– Show shared config layers (environment variables, .env, configuration.ts).
– If relevant, overlay CI/CD or Docker Compose orchestration.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% User Interaction
    User["User"]:::external

    %% Frontend Layer
    subgraph "Frontend Layer" 
        direction TB
        FrontendApp["apps/web (Next.js App)"]:::frontend
        UIlib["packages/ui (Shared UI Library)"]:::frontend
        NextAuthRoute["NextAuth Route"]:::frontend
        APIClient["services/api.ts (API Client)"]:::frontend
        TailwindConfig["tailwind.config.mjs"]:::frontend
        UILibComponents["packages/ui/src/components"]:::frontend
    end

    %% Backend Layer
    subgraph "Backend API Layer"
        direction TB
        MainEntry["apps/api/src/main.ts"]:::backend
        BackendRoot["apps/api/src/app.module.ts"]:::backend
        AuthModule["Auth Module"]:::backend
        UsersModule["Users Module"]:::backend
        ClientsModule["Clients Module"]:::backend
        CompaniesModule["Companies Module"]:::backend
        DocumentsModule["Documents Module"]:::backend
        HMRCModule["HMRC Integration Module"]:::backend
        UploadModule["Uploads Module"]:::backend
        MailModule["Mailing Module"]:::backend
        RolesModule["Roles & Guards Module"]:::backend
        CommonUtils["Common Utilities"]:::backend
        ConfigModule["Configuration"]:::backend
    end

    %% Database Layer
    subgraph "Database Layer"
        direction TB
        DrizzleConfig["drizzle.config.ts"]:::database
        Migrations["drizzle (Migrations)"]:::database
        SchemaDef["src/schema"]:::database
        CLI_Migrate["migrate.ts"]:::database
        CLI_Seed["seed.ts"]:::database
        DB["PostgreSQL (Drizzle ORM)"]:::database
    end

    %% External Services
    subgraph "External Services"
        direction TB
        S3["AWS S3"]:::external
        HMRCService["HMRC API"]:::external
        EmailService["Email Provider (SMTP/SES)"]:::external
    end

    %% Monorepo Tooling
    subgraph "Monorepo Tooling"
        direction TB
        WorkspaceConfig["pnpm-workspace.yaml"]:::tool
        TurboConfig["turbo.json"]:::tool
        ESLintConfig["packages/eslint-config"]:::tool
        TSConfig["packages/typescript-config"]:::tool
        DockerCompose["docker-compose.yml"]:::tool
    end

    %% Connections - User to Frontend
    User -->|"interacts with"| FrontendApp

    %% Frontend imports and routes
    FrontendApp -->|"imports UI components"| UIlib
    FrontendApp -->|"uses Tailwind & shadcn/UI"| TailwindConfig
    FrontendApp -->|"NextAuth login"| NextAuthRoute
    FrontendApp -->|"calls"| APIClient

    %% Frontend to Backend
    APIClient -->|"REST HTTPS"| BackendRoot

    %% Backend internal wiring
    MainEntry -->|"bootstraps"| BackendRoot
    BackendRoot --> AuthModule
    BackendRoot --> UsersModule
    BackendRoot --> ClientsModule
    BackendRoot --> CompaniesModule
    BackendRoot --> DocumentsModule
    BackendRoot --> HMRCModule
    BackendRoot --> UploadModule
    BackendRoot --> MailModule
    BackendRoot --> RolesModule
    BackendRoot --> CommonUtils
    BackendRoot --> ConfigModule

    %% Backend to Database
    BackendRoot -->|"reads/writes"| DB
    ConfigModule --> DrizzleConfig
    DrizzleConfig --> Migrations
    DrizzleConfig --> SchemaDef
    DrizzleConfig --> CLI_Migrate
    DrizzleConfig --> CLI_Seed
    Migrations --> DB
    SchemaDef --> DB
    CLI_Migrate --> DB
    CLI_Seed --> DB

    %% Backend to External Services
    UploadModule -->|"PUT/GET"| S3
    HMRCModule -->|"REST API"| HMRCService
    MailModule -->|"SMTP/SES"| EmailService

    %% Monorepo tooling references
    FrontendApp --> WorkspaceConfig
    BackendRoot --> WorkspaceConfig
    UIlib --> WorkspaceConfig
    WorkspaceConfig --> TurboConfig
    WorkspaceConfig --> ESLintConfig
    WorkspaceConfig --> TSConfig
    WorkspaceConfig --> DockerCompose

    %% Click Events
    click UIlib "https://github.com/nambui98/mtd-tax/tree/main/packages/ui"
    click FrontendApp "https://github.com/nambui98/mtd-tax/tree/main/apps/web"
    click NextAuthRoute "https://github.com/nambui98/mtd-tax/blob/main/apps/web/app/api/auth/[...nextauth]/route.ts"
    click APIClient "https://github.com/nambui98/mtd-tax/blob/main/apps/web/services/api.ts"
    click TailwindConfig "https://github.com/nambui98/mtd-tax/blob/main/apps/web/tailwind.config.mjs"
    click UILibComponents "https://github.com/nambui98/mtd-tax/tree/main/packages/ui/src/components"
    click MainEntry "https://github.com/nambui98/mtd-tax/blob/main/apps/api/src/main.ts"
    click BackendRoot "https://github.com/nambui98/mtd-tax/blob/main/apps/api/src/app.module.ts"
    click AuthModule "https://github.com/nambui98/mtd-tax/tree/main/apps/api/src/modules/auth"
    click UsersModule "https://github.com/nambui98/mtd-tax/tree/main/apps/api/src/modules/users"
    click ClientsModule "https://github.com/nambui98/mtd-tax/tree/main/apps/api/src/modules/clients"
    click CompaniesModule "https://github.com/nambui98/mtd-tax/tree/main/apps/api/src/modules/companies"
    click DocumentsModule "https://github.com/nambui98/mtd-tax/tree/main/apps/api/src/modules/documents"
    click HMRCModule "https://github.com/nambui98/mtd-tax/tree/main/apps/api/src/modules/hmrc"
    click UploadModule "https://github.com/nambui98/mtd-tax/tree/main/apps/api/src/modules/upload"
    click MailModule "https://github.com/nambui98/mtd-tax/tree/main/apps/api/src/modules/mail"
    click RolesModule "https://github.com/nambui98/mtd-tax/tree/main/apps/api/src/modules/roles"
    click CommonUtils "https://github.com/nambui98/mtd-tax/tree/main/apps/api/src/common"
    click ConfigModule "https://github.com/nambui98/mtd-tax/blob/main/apps/api/src/config/configuration.ts"
    click DrizzleConfig "https://github.com/nambui98/mtd-tax/blob/main/packages/database/drizzle.config.ts"
    click Migrations "https://github.com/nambui98/mtd-tax/tree/main/packages/database/drizzle"
    click SchemaDef "https://github.com/nambui98/mtd-tax/tree/main/packages/database/src/schema"
    click CLI_Migrate "https://github.com/nambui98/mtd-tax/blob/main/packages/database/migrate.ts"
    click CLI_Seed "https://github.com/nambui98/mtd-tax/blob/main/packages/database/seed.ts"
    click WorkspaceConfig "https://github.com/nambui98/mtd-tax/blob/main/pnpm-workspace.yaml"
    click TurboConfig "https://github.com/nambui98/mtd-tax/blob/main/turbo.json"
    click ESLintConfig "https://github.com/nambui98/mtd-tax/tree/main/packages/eslint-config"
    click TSConfig "https://github.com/nambui98/mtd-tax/tree/main/packages/typescript-config"
    click DockerCompose "https://github.com/nambui98/mtd-tax/blob/main/docker-compose.yml"

    %% Styles
    classDef frontend fill:#cce5ff,stroke:#1f78b4,color:#000;
    classDef backend fill:#d4edda,stroke:#238b45,color:#000;
    classDef database fill:#f8d7da,stroke:#b02a37,color:#000;
    classDef external fill:#fff3cd,stroke:#e08e0b,color:#000;
    classDef tool fill:#e2e3e5,stroke:#6c757d,color:#000;
```
