# rubiin/ultimate-nest architecture

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

- Interactive diagram: https://gitdiagram.com/rubiin/ultimate-nest
- Repository: https://github.com/rubiin/ultimate-nest

## Overview

##### Main System Components

a) Core Application Layer:
- NestJS Application Server
- WebSocket Gateway (for real-time chat)
- Worker Threads Pool (for CPU-intensive tasks)

b) External Services:
- PostgreSQL Database (via MikroORM)
- Redis Cache
- RabbitMQ Message Broker
- External Services:
- AWS S3/Cloudinary (file storage)
- Twilio (SMS)
- OAuth Providers (Google, Facebook)

##### Module Organization

- Auth Module
- User Module
- Post Module
- Chat Module
- Category Module
- Newsletter Module
- Profile Module
- Tags Module
- Two-Factor Authentication Module

##### Cross-Cutting Concerns

Architectural layers:
- Guards (Authentication, Authorization)
- Interceptors (Caching, Logging, Timeout)
- Filters (Exception Handling)
- Pipes (Validation)
- Middleware (IP, Request ID, Maintenance)

##### Key Relationships

a) Authentication Flow:
- JWT-based authentication
- OAuth2 integration
- Two-factor authentication
- Magic link authentication

b) Data Flow:
- Request handling through middleware → guards → interceptors → controllers → services
- Database interactions through repositories
- Cache layer interactions
- File upload handling
- WebSocket connections for chat

##### Additional Elements

Components:
- I18n integration for internationalization
- CASL-based authorization
- Swagger API documentation endpoint
- Health check endpoints
- Monitoring and metrics collection points

##### Deployment Architecture

Containerized deployment structure:
- Docker containers
- Traefik reverse proxy
- Load balancing
- Service discovery

##### Documentation Notes

Annotations for:
- Security measures (Helmet, JWT, RSA256)
- Performance optimizations (Redis caching, worker threads)
- Scalability points (horizontal scaling capabilities)
- Database migration and seeding processes

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Core["Core Application Layer"]
        NestJS["NestJS Application Server"]
        WS["WebSocket Gateway"]:::websocket
        Workers["Worker Threads Pool"]
    end

    subgraph Modules["Application Modules"]
        direction TB
        Auth["Auth Module"]:::module
        User["User Module"]:::module
        Post["Post Module"]:::module
        Chat["Chat Module"]:::module
        Category["Category Module"]:::module
        Newsletter["Newsletter Module"]:::module
        Profile["Profile Module"]:::module
        Tags["Tags Module"]:::module
        TwoFA["Two-Factor Auth Module"]:::module
    end

    subgraph CrossCutting["Cross-Cutting Concerns"]
        Guards["Guards"]:::security
        Interceptors["Interceptors"]:::security
        Filters["Filters"]:::security
        Pipes["Pipes"]:::security
        Middleware["Middleware"]:::security
    end

    subgraph External["External Services"]
        direction TB
        DB[(PostgreSQL)]:::database
        Redis[(Redis Cache)]:::database
        RabbitMQ[("RabbitMQ")]:::messaging
        AWS["AWS S3"]:::external
        Cloudinary["Cloudinary"]:::external
        Twilio["Twilio SMS"]:::external
        OAuth["OAuth Providers"]:::external
    end

    subgraph Auth_Flow["Authentication"]
        JWT["JWT Strategy"]:::auth
        MagicLink["Magic Link"]:::auth
        OAuth_Strat["OAuth Strategies"]:::auth
    end

    subgraph Deploy["Deployment"]
        Docker["Docker Containers"]
        Traefik["Traefik Proxy"]
        LoadBalancer["Load Balancing"]
    end

    NestJS --> |Uses| Modules
    NestJS --> |Implements| CrossCutting
    NestJS --> |Connects| External
    WS --> Chat
    Auth --> JWT
    Auth --> MagicLink
    Auth --> OAuth_Strat
    OAuth_Strat --> OAuth

    %% Component Mappings
    click Auth "https://github.com/rubiin/ultimate-nest/tree/master/src/modules/auth"
    click User "https://github.com/rubiin/ultimate-nest/tree/master/src/modules/user"
    click Post "https://github.com/rubiin/ultimate-nest/tree/master/src/modules/post"
    click Chat "https://github.com/rubiin/ultimate-nest/tree/master/src/modules/chat"
    click Category "https://github.com/rubiin/ultimate-nest/tree/master/src/modules/category"
    click Newsletter "https://github.com/rubiin/ultimate-nest/tree/master/src/modules/newsletter"
    click Profile "https://github.com/rubiin/ultimate-nest/tree/master/src/modules/profile"
    click Tags "https://github.com/rubiin/ultimate-nest/tree/master/src/modules/tags"
    click TwoFA "https://github.com/rubiin/ultimate-nest/tree/master/src/modules/twofa"
    click AWS "https://github.com/rubiin/ultimate-nest/tree/master/src/lib/aws"
    click Cloudinary "https://github.com/rubiin/ultimate-nest/blob/master/src/lib/cloudinary.module.ts"
    click Twilio "https://github.com/rubiin/ultimate-nest/tree/master/src/lib/twilio"
    click Redis "https://github.com/rubiin/ultimate-nest/tree/master/src/lib/cache"
    click RabbitMQ "https://github.com/rubiin/ultimate-nest/tree/master/src/lib/rabbit"
    click Guards "https://github.com/rubiin/ultimate-nest/tree/master/src/common/guards"
    click Interceptors "https://github.com/rubiin/ultimate-nest/tree/master/src/common/interceptors"
    click Filters "https://github.com/rubiin/ultimate-nest/tree/master/src/common/filters"
    click Pipes "https://github.com/rubiin/ultimate-nest/tree/master/src/common/pipes"
    click Middleware "https://github.com/rubiin/ultimate-nest/tree/master/src/common/middlewares"
    click JWT "https://github.com/rubiin/ultimate-nest/blob/master/src/modules/auth/strategies/jwt.strategy.ts"
    click MagicLink "https://github.com/rubiin/ultimate-nest/blob/master/src/modules/auth/strategies/magic-login.strategy.ts"
    click WS "https://github.com/rubiin/ultimate-nest/blob/master/src/modules/chat/chat.gateway.ts"

    classDef module fill:#a8d5ff,stroke:#333,stroke-width:2px
    classDef security fill:#ff9999,stroke:#333,stroke-width:2px
    classDef database fill:#c2f0c2,stroke:#333,stroke-width:2px
    classDef messaging fill:#ffb366,stroke:#333,stroke-width:2px
    classDef external fill:#d9b3ff,stroke:#333,stroke-width:2px
    classDef auth fill:#ffcc99,stroke:#333,stroke-width:2px
    classDef websocket fill:#99ffcc,stroke:#333,stroke-width:2px

    %% Legend
    subgraph Legend
        M1["Module"]:::module
        S1["Security Component"]:::security
        D1["Database"]:::database
        MS1["Message Queue"]:::messaging
        E1["External Service"]:::external
        A1["Auth Component"]:::auth
        W1["WebSocket"]:::websocket
    end
```
