# agodin3z/nest-typeorm-template architecture

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

- Interactive diagram: https://gitdiagram.com/agodin3z/nest-typeorm-template
- Repository: https://github.com/agodin3z/nest-typeorm-template

## Overview

##### Main Components Identification

a. Core Application Layer
- Main Application Module
- Configuration Management
- Authentication System
- Common Services/Utilities

b. Module Layer
- Users Module
- Roles Module
- Health Module

c. Database Layer
- TypeORM Integration
- Migrations
- Seeds

d. Security Layer
- JWT Authentication
- API Key Authentication
- Guards

- Main Application (app.module)
- Configuration (common/config)
- Authentication (common/auth)
- Common Services (common/services)

- Users Module
- Controllers
- Services
- DTOs
- Entities
- Roles Module
- Controllers
- Services
- DTOs
- Entities
- Health Module

- TypeORM Service
- Migrations
- Seeds

##### Specific Design Elements

Use the following visual elements:

a. Components:
- Rectangles: Modules and Services
- Hexagons: Guards and Middleware
- Diamonds: Decision Points (Authentication)

b. Connections:
- Double lines: Database connections

- Blue: Core application components
- Green: Feature modules
- Yellow: Security components
- Gray: Database components
- Red: Critical services (Authentication, Encryption)

##### Important Relationships to Highlight

- How the AuthModule and Guards protect the routes
- Relationship between Users and Roles (many-to-many)
- TypeORM service connection to all entities
- How the middleware (logger) intercepts requests

##### Technical Stack Indicators

- NestJS (Framework)
- TypeORM (Database ORM)
- JWT (Authentication)
- MySQL (Database)

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph External
        Client["HTTP Clients"]
        APIConsumers["API Consumers"]
        AuthReq["Authentication Requests"]
    end

    subgraph AppLayer["Application Layer"]
        AppModule["Main Application Module"]:::core
        click AppModule "https://github.com/agodin3z/nest-typeorm-template/blob/main/src/app.module.ts"
        
        subgraph Config["Configuration"]
            ConfigMgmt["Configuration Management"]:::config
            Validation["Validation"]:::config
            click ConfigMgmt "https://github.com/agodin3z/nest-typeorm-template/blob/main/src/common/config/configuration.ts"
            click Validation "https://github.com/agodin3z/nest-typeorm-template/blob/main/src/common/config/validation.ts"
        end

        subgraph Auth["Authentication"]
            AuthModule["Auth Module"]:::security
            JWTStrategy["JWT Strategy"]:::security
            APIKeyStrategy["API Key Strategy"]:::security
            click AuthModule "https://github.com/agodin3z/nest-typeorm-template/blob/main/src/common/auth/auth.module.ts"
            click JWTStrategy "https://github.com/agodin3z/nest-typeorm-template/blob/main/src/common/auth/strategies/jwt.strategy.ts"
            click APIKeyStrategy "https://github.com/agodin3z/nest-typeorm-template/blob/main/src/common/auth/strategies/api-key.strategy.ts"
        end

        subgraph Security["Security Layer"]
            JWTGuard{{"JWT Guard"}}:::security
            APIKeyGuard{{"API Key Guard"}}:::security
            click JWTGuard "https://github.com/agodin3z/nest-typeorm-template/blob/main/src/common/guards/jwt.guard.ts"
            click APIKeyGuard "https://github.com/agodin3z/nest-typeorm-template/blob/main/src/common/guards/api-key.guard.ts"
        end

        subgraph Common["Common Services"]
            EncryptionService["Encryption Service"]:::core
            JoiPipe["Joi Validation Pipe"]:::core
            LoggerMiddleware["Logger Middleware"]:::core
            click EncryptionService "https://github.com/agodin3z/nest-typeorm-template/blob/main/src/common/services/encryption.service.ts"
            click JoiPipe "https://github.com/agodin3z/nest-typeorm-template/blob/main/src/common/pipes/joi.pipe.ts"
            click LoggerMiddleware "https://github.com/agodin3z/nest-typeorm-template/blob/main/src/middleware/logger.middleware.ts"
        end
    end

    subgraph ModulesLayer["Feature Modules"]
        subgraph Users["Users Module"]
            UsersModule["Users Module"]:::module
            UserController["User Controller"]:::module
            UserService["User Service"]:::module
            UserEntity["User Entity"]:::module
            UserSubscriber["Users Subscriber"]:::module
            click UsersModule "https://github.com/agodin3z/nest-typeorm-template/blob/main/src/modules/users/users.module.ts"
            click UserController "https://github.com/agodin3z/nest-typeorm-template/blob/main/src/modules/users/controllers/user.controller.ts"
            click UserService "https://github.com/agodin3z/nest-typeorm-template/blob/main/src/modules/users/services/user.service.ts"
            click UserEntity "https://github.com/agodin3z/nest-typeorm-template/blob/main/src/modules/users/entities/user.entity.ts"
            click UserSubscriber "https://github.com/agodin3z/nest-typeorm-template/blob/main/src/modules/users/users.subscriber.ts"
        end

        subgraph Roles["Roles Module"]
            RolesModule["Roles Module"]:::module
            RoleController["Role Controller"]:::module
            RoleService["Role Service"]:::module
            RoleEntity["Role Entity"]:::module
            click RolesModule "https://github.com/agodin3z/nest-typeorm-template/blob/main/src/modules/roles/roles.module.ts"
            click RoleController "https://github.com/agodin3z/nest-typeorm-template/blob/main/src/modules/roles/controllers/role.controller.ts"
            click RoleService "https://github.com/agodin3z/nest-typeorm-template/blob/main/src/modules/roles/services/role.service.ts"
            click RoleEntity "https://github.com/agodin3z/nest-typeorm-template/blob/main/src/modules/roles/entities/role.entity.ts"
        end

        subgraph Health["Health Module"]
            HealthModule["Health Module"]:::module
            HealthController["Health Controller"]:::module
            click HealthModule "https://github.com/agodin3z/nest-typeorm-template/blob/main/src/health/health.module.ts"
            click HealthController "https://github.com/agodin3z/nest-typeorm-template/blob/main/src/health/health.controller.ts"
        end
    end

    subgraph DBLayer["Database Layer"]
        DBModule["Database Module"]:::database
        TypeORMService["TypeORM Service"]:::database
        Migrations["Migrations"]:::database
        Seeds["Seeds"]:::database
        GlobalSubscriber["Global Subscriber"]:::database
        click DBModule "https://github.com/agodin3z/nest-typeorm-template/blob/main/src/database/database.module.ts"
        click TypeORMService "https://github.com/agodin3z/nest-typeorm-template/blob/main/src/database/services/typeorm.service.ts"
        click Migrations "https://github.com/agodin3z/nest-typeorm-template/blob/main/src/database/migrations/1683749008743-generated.ts"
        click Seeds "https://github.com/agodin3z/nest-typeorm-template/blob/main/src/database/seeds/roles.seed.ts"
        click GlobalSubscriber "https://github.com/agodin3z/nest-typeorm-template/blob/main/src/modules/global.subscriber.ts"
    end

    %% Connections
    Client --> LoggerMiddleware
    APIConsumers --> LoggerMiddleware
    AuthReq --> AuthModule
    LoggerMiddleware --> AppModule
    AppModule --> AuthModule
    AuthModule --> JWTStrategy & APIKeyStrategy
    JWTStrategy --> JWTGuard
    APIKeyStrategy --> APIKeyGuard
    JWTGuard & APIKeyGuard --> ModulesLayer
    AppModule --> ConfigMgmt
    ConfigMgmt --> Validation
    AppModule --> Common
    AppModule --> ModulesLayer
    UsersModule --> UserController --> UserService --> UserEntity
    RolesModule --> RoleController --> RoleService --> RoleEntity
    HealthModule --> HealthController
    UserEntity --> UserSubscriber
    DBModule --> TypeORMService
    TypeORMService --> Migrations & Seeds
    TypeORMService --> GlobalSubscriber
    UserEntity <--> RoleEntity

    %% Styles
    classDef core fill:#2196F3,color:white
    classDef config fill:#4CAF50,color:white
    classDef security fill:#FFC107,color:black
    classDef module fill:#9C27B0,color:white
    classDef database fill:#607D8B,color:white

    %% Legend
    subgraph Legend
        CoreComponent["Core Component"]:::core
        ConfigComponent["Configuration"]:::config
        SecurityComponent["Security"]:::security
        ModuleComponent["Module"]:::module
        DatabaseComponent["Database"]:::database
    end
```
