# umcignal/umcignal-server architecture

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

- Interactive diagram: https://gitdiagram.com/umcignal/umcignal-server
- Repository: https://github.com/umcignal/umcignal-server

## Overview

##### Project Type and Purpose
- This project is a backend API server built using Express and TypeScript. It is meant to serve as a well-structured RESTful API that connects with a MySQL database and leverages Redis for caching or session management.
- The code follows a layered architecture that separates concerns into configuration, middleware, routing, controllers, services, data models, and additional modules (e.g., authentication and security features).

##### File Structure
- The main application entry point is found in dist/index.ts.
- Core application logic is organized within the “dist” folder and is further subdivided by domain:
- Each domain such as healthCheck, idelType (likely a typo for idleType), operating, referralCode, search, serialCode, and user is separated into its own directory.
- Within each domain folder, there is a clear pattern: each module has a router (defining routes), a controller (handling request logic), a service (business logic), a model (database or ORM interactions), and sometimes data transfer objects (DTOs) for input validation or transformation.
- The project uses multiple layers of middleware stored under dist/middlware for error handling, authentication, validation, operating, and more.
- Configuration makes use of defined files such as dist/config/database/mysqlConnect.ts and a swagger.ts for API documentation, along with GitHub workflows for CI/CD in .github/workflows.
- Security features (JWT, mail sender, validation) are implemented in separate directories (dist/security), further emphasizing a modular architecture.

##### Final Steps and Details
- Do not oversimplify – break down each module as far as possible while ensuring clarity.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% API Entry Point and Middleware
    A["API Gateway"]:::api
    MW["Global Middleware"]:::middleware
    A -->|"HTTP_Request"| MW
    MW -->|"Cache/Session"| Redis["Redis Cache"]:::external

    %% Domain Modules
    MW --> HR["HealthCheck Router"]:::router
    HR --> HC["HealthCheck Controller"]:::controller

    MW --> IR["IdleType Router"]:::router
    subgraph "IdleType Domain"
        IR["IdleType Router"]:::router
        IC["IdleType Controller"]:::controller
        IS["IdleType Service"]:::service
        IM["IdleType Model"]:::model
        IDTO["IdleType DTO"]:::dto
        IR --> IC
        IC --> IS
        IC --> IDTO
        IS --> IM
    end

    MW --> OR["Operating Router"]:::router
    subgraph "Operating Domain"
        OR["Operating Router"]:::router
        OC["Operating Controller"]:::controller
        OS["Operating Service"]:::service
        OM["Operating Model"]:::model
        OR --> OC
        OC --> OS
        OS --> OM
    end

    MW --> RR["Referral Router"]:::router
    subgraph "ReferralCode Domain"
        RR["Referral Router"]:::router
        RC["Referral Controller"]:::controller
        RS["Referral Service"]:::service
        RM["Referral Model"]:::model
        RR --> RC
        RC --> RS
        RS --> RM
    end

    MW --> SDR["Search Router"]:::router
    subgraph "Search Domain"
        SDR["Search Router"]:::router
        SDC["Search Controller"]:::controller
        SS["Search Service"]:::service
        SM["Search Model"]:::model
        SDT["Search DTO"]:::dto
        SDR --> SDC
        SDC --> SS
        SDC --> SDT
        SS --> SM
    end

    MW --> SER["Serial Router"]:::router
    subgraph "SerialCode Domain"
        SER["Serial Router"]:::router
        SEC["Serial Controller"]:::controller
        SES["Serial Service"]:::service
        SMOD["Serial Model"]:::model
        SER --> SEC
        SEC --> SES
        SES --> SMOD
    end

    MW --> UR["User Router"]:::router
    subgraph "User Domain"
        UR["User Router"]:::router
        UC["User Controller"]:::controller
        US["User Service"]:::service
        UM["User Model"]:::model
        UDT["User DTO"]:::dto
        UR --> UC
        UC --> US
        UC --> UDT
        US --> UM
    end

    %% Service to Database Connections
    IS ---|"DB_IO"| MySQLDB["MySQL Database"]:::external
    OS ---|"DB_IO"| MySQLDB
    RS ---|"DB_IO"| MySQLDB
    SS ---|"DB_IO"| MySQLDB
    SES ---|"DB_IO"| MySQLDB
    US ---|"DB_IO"| MySQLDB

    %% Configuration Components
    subgraph "Configuration"
        MYSQLConfig["MySQL Connection"]:::config
        Schema["Database Schema"]:::config
        Swagger["Swagger Documentation"]:::config
    end
    MYSQLConfig --> MySQLDB
    Schema --> MySQLDB
    Swagger --> MYSQLConfig
    GITHUB["GitHub Workflows (CI/CD)"]:::config

    %% Security Modules
    subgraph "Security Modules"
        JWT["JWT Module"]:::security
        Mail["Mail Sender"]:::security
        Validation["Validation Module"]:::security
    end
    JWT ---|"Auth_Check"| MW
    Validation ---|"Input_Validation"| MW
    Mail ---|"Notify"| MW

    %% Click Events
    click A "https://github.com/umcignal/umcignal-server/blob/dev/dist/index.ts"
    click MW "https://github.com/umcignal/umcignal-server/tree/dev/dist/middlware"
    
    click HR "https://github.com/umcignal/umcignal-server/blob/dev/dist/healthCheck/health.router.ts"
    click HC "https://github.com/umcignal/umcignal-server/blob/dev/dist/healthCheck/health.controller/health.controller.ts"
    
    click IR "https://github.com/umcignal/umcignal-server/blob/dev/dist/idelType/idelType.router.ts"
    click IC "https://github.com/umcignal/umcignal-server/blob/dev/dist/idelType/idleType.controller/idleType.controller.ts"
    click IDTO "https://github.com/umcignal/umcignal-server/blob/dev/dist/idelType/idleType.dto/idleType.dto.ts"
    click IM "https://github.com/umcignal/umcignal-server/blob/dev/dist/idelType/idleType.model/idleType.model.ts"
    click IS "https://github.com/umcignal/umcignal-server/blob/dev/dist/idelType/idleType.service/idleType.service.ts"
    
    click OR "https://github.com/umcignal/umcignal-server/blob/dev/dist/operating/operating.router.ts"
    click OC "https://github.com/umcignal/umcignal-server/blob/dev/dist/operating/operating.contoroller/operating.controller.ts"
    click OM "https://github.com/umcignal/umcignal-server/blob/dev/dist/operating/operating.model/operating.model.ts"
    click OS "https://github.com/umcignal/umcignal-server/blob/dev/dist/operating/operating.service/operating.service.ts"
    
    click RR "https://github.com/umcignal/umcignal-server/blob/dev/dist/referralCode/referral.router.ts"
    click RC "https://github.com/umcignal/umcignal-server/blob/dev/dist/referralCode/referral.controller/referral.controller.ts"
    click RM "https://github.com/umcignal/umcignal-server/blob/dev/dist/referralCode/referral.model/referral.model.ts"
    click RS "https://github.com/umcignal/umcignal-server/blob/dev/dist/referralCode/referral.service/referral.service.ts"
    
    click SDR "https://github.com/umcignal/umcignal-server/blob/dev/dist/search/search.router.ts"
    click SDC "https://github.com/umcignal/umcignal-server/blob/dev/dist/search/search.controller/search.controller.ts"
    click SDT "https://github.com/umcignal/umcignal-server/blob/dev/dist/search/search.dto/search.dto.ts"
    click SM "https://github.com/umcignal/umcignal-server/blob/dev/dist/search/search.model/search.model.ts"
    click SS "https://github.com/umcignal/umcignal-server/blob/dev/dist/search/search.service/search.service.ts"
    
    click SER "https://github.com/umcignal/umcignal-server/blob/dev/dist/serialCode/serialCode.router.ts"
    click SEC "https://github.com/umcignal/umcignal-server/blob/dev/dist/serialCode/serialCode.controller/serialCode.controller.ts"
    click SMOD "https://github.com/umcignal/umcignal-server/blob/dev/dist/serialCode/sericalCode.model/sericalCode.model.ts"
    click SES "https://github.com/umcignal/umcignal-server/blob/dev/dist/serialCode/serialCode.service/serialCode.service.ts"
    
    click UR "https://github.com/umcignal/umcignal-server/blob/dev/dist/user/user.router.ts"
    click UC "https://github.com/umcignal/umcignal-server/blob/dev/dist/user/user.controller/user.controller.ts"
    click UDT "https://github.com/umcignal/umcignal-server/blob/dev/dist/user/user.dto/user.dto.ts"
    click UM "https://github.com/umcignal/umcignal-server/blob/dev/dist/user/user.model/user.model.ts"
    click US "https://github.com/umcignal/umcignal-server/blob/dev/dist/user/user.service/user.service.ts"
    
    click MYSQLConfig "https://github.com/umcignal/umcignal-server/blob/dev/dist/config/database/mysqlConnect.ts"
    click Schema "https://github.com/umcignal/umcignal-server/blob/dev/dist/config/database/shecma.ts"
    click Swagger "https://github.com/umcignal/umcignal-server/blob/dev/dist/config/swagger.ts"
    click JWT "https://github.com/umcignal/umcignal-server/tree/dev/dist/security/JWT"
    click Mail "https://github.com/umcignal/umcignal-server/blob/dev/dist/security/mail/mail.sender.ts"
    click Validation "https://github.com/umcignal/umcignal-server/blob/dev/dist/security/validation/validation.ts"
    click GITHUB "https://github.com/umcignal/umcignal-server/tree/dev/.github/workflows"

    %% Styles
    classDef api fill:#ADD8E6,stroke:#000,stroke-width:2px;
    classDef router fill:#90EE90,stroke:#000,stroke-width:1px;
    classDef controller fill:#87CEFA,stroke:#000,stroke-width:1px;
    classDef service fill:#FFD700,stroke:#000,stroke-width:1px;
    classDef model fill:#FFA500,stroke:#000,stroke-width:1px;
    classDef dto fill:#F4A460,stroke:#000,stroke-width:1px;
    classDef middleware fill:#FF6347,stroke:#000,stroke-width:1px;
    classDef config fill:#9370DB,stroke:#000,stroke-width:1px;
    classDef security fill:#DA70D6,stroke:#000,stroke-width:1px;
    classDef external fill:#A9A9A9,stroke:#000,stroke-width:1px;
```
