# check-data-out/velog-dashboard-v2-api architecture

> Architecture diagram of the GitHub repository check-data-out/velog-dashboard-v2-api, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/check-data-out/velog-dashboard-v2-api
- Repository: https://github.com/check-data-out/velog-dashboard-v2-api

## Overview

##### Main System Components

a) Client Layer
- External clients (Web/Mobile applications)
- Nginx reverse proxy (evident from nginx configuration files)

b) Application Layer
- Express.js API Server
- Authentication/Authorization System (visible from auth.middleware.ts)
- Token Encryption Module (from token_encryption directory)

c) Data Layer
- Database (indicated by db.config.ts)

##### Architectural Pattern

**Controllers -> Services -> Repositories -> Database**

##### Detailed Component Breakdown

a) API Layer (Controllers)
- Post Controller
- User Controller
- Tracking Controller

b) Service Layer
- Post Service
- User Service
- Tracking Service

c) Repository Layer
- Post Repository
- User Repository
- Tracking Repository

d) Cross-Cutting Concerns
- Error Handling Middleware
- Validation Middleware
- Authentication Middleware
- Logging System (logger.config.ts)

##### Data Flow Representation

- Client requests through Nginx to the API endpoints
- Request flow through middleware
- Business logic flow through services
- Data access through repositories
- Error handling flow

**┌─ External Layer ─┐  ┌─ Application Layer ─┐  ┌─ Data Layer ─┐**
- Nginx         │  │ - Controllers       │  │ - Repositories│
- Clients       │──>│ - Services         │──>│ - Database   │
- ┘  │ - Middleware        │  └──────────────┘
- ┘

##### Additional Notes

- Notes about the authentication flow
- Event tracking system's flow
- Statistics aggregation process
- Error handling paths

##### Technical Stack Indicators

Following technologies:
- Node.js/Express.js
- TypeScript
- Nginx
- Database system (from db.config.ts)

This system design should effectively communicate both the overall architecture and the specific implementation details of the Velog Dashboard backend API server.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph External
        Client["Client Applications"]
        Nginx["Nginx Reverse Proxy"]:::proxy
    end

    subgraph API_Layer
        PostController["Post Controller"]:::controller
        UserController["User Controller"]:::controller
        TrackController["Tracking Controller"]:::controller
        
        PostRouter["Post Router"]:::router
        UserRouter["User Router"]:::router
        TrackRouter["Tracking Router"]:::router
    end

    subgraph Middleware
        AuthMW["Authentication"]:::middleware
        ErrorMW["Error Handling"]:::middleware
        ValidMW["Validation"]:::middleware
    end

    subgraph Service_Layer
        PostService["Post Service"]:::service
        UserService["User Service"]:::service
        TrackService["Tracking Service"]:::service
    end

    subgraph Repository_Layer
        PostRepo["Post Repository"]:::repository
        UserRepo["User Repository"]:::repository
        TrackRepo["Tracking Repository"]:::repository
    end

    subgraph Data_Models
        Post["Post Model"]:::model
        User["User Model"]:::model
        PostStats["Post Statistics"]:::model
        DailyStats["Daily Statistics"]:::model
        PageVisits["Page Visits"]:::model
        EventTrack["Event Tracking"]:::model
    end

    subgraph Config
        DBConfig["Database Config"]:::config
        LogConfig["Logger Config"]:::config
        SwaggerConfig["Swagger Config"]:::config
    end

    subgraph Security
        TokenEncrypt["Token Encryption"]:::security
        CustomExcept["Custom Exceptions"]:::security
        DBExcept["Database Exceptions"]:::security
        AuthExcept["Auth Exceptions"]:::security
        ReqExcept["Request Exceptions"]:::security
    end

    Database[(Database)]:::database

    Client --> Nginx
    Nginx --> PostRouter & UserRouter & TrackRouter

    PostRouter --> AuthMW --> PostController
    UserRouter --> AuthMW --> UserController
    TrackRouter --> AuthMW --> TrackController

    PostController --> ValidMW --> PostService
    UserController --> ValidMW --> UserService
    TrackController --> ValidMW --> TrackService

    PostService --> PostRepo
    UserService --> UserRepo
    TrackService --> TrackRepo

    PostRepo & UserRepo & TrackRepo --> Database

    ErrorMW -.-> PostController & UserController & TrackController
    TokenEncrypt -.-> AuthMW

    classDef proxy fill:#1E88E5
    classDef controller fill:#4CAF50
    classDef service fill:#FFC107
    classDef repository fill:#FF9800
    classDef middleware fill:#9E9E9E
    classDef model fill:#673AB7
    classDef config fill:#00BCD4
    classDef security fill:#F44336
    classDef database fill:#7E57C2
    classDef router fill:#26A69A

    click Nginx "https://github.com/Check-Data-Out/velog-dashboard-v2-api/tree/main/nginx"
    click PostController "https://github.com/Check-Data-Out/velog-dashboard-v2-api/blob/main/src/controllers/post.controller.ts"
    click UserController "https://github.com/Check-Data-Out/velog-dashboard-v2-api/blob/main/src/controllers/user.controller.ts"
    click TrackController "https://github.com/Check-Data-Out/velog-dashboard-v2-api/blob/main/src/controllers/tracking.controller.ts"
    click PostService "https://github.com/Check-Data-Out/velog-dashboard-v2-api/blob/main/src/services/post.service.ts"
    click UserService "https://github.com/Check-Data-Out/velog-dashboard-v2-api/blob/main/src/services/user.service.ts"
    click TrackService "https://github.com/Check-Data-Out/velog-dashboard-v2-api/blob/main/src/services/tracking.service.ts"
    click PostRepo "https://github.com/Check-Data-Out/velog-dashboard-v2-api/blob/main/src/repositories/post.repository.ts"
    click UserRepo "https://github.com/Check-Data-Out/velog-dashboard-v2-api/blob/main/src/repositories/user.repository.ts"
    click TrackRepo "https://github.com/Check-Data-Out/velog-dashboard-v2-api/blob/main/src/repositories/tracking.repository.ts"
    click AuthMW "https://github.com/Check-Data-Out/velog-dashboard-v2-api/blob/main/src/middlewares/auth.middleware.ts"
    click ErrorMW "https://github.com/Check-Data-Out/velog-dashboard-v2-api/blob/main/src/middlewares/errorHandling.middleware.ts"
    click ValidMW "https://github.com/Check-Data-Out/velog-dashboard-v2-api/blob/main/src/middlewares/validation.middleware.ts"
    click DBConfig "https://github.com/Check-Data-Out/velog-dashboard-v2-api/blob/main/src/configs/db.config.ts"
    click LogConfig "https://github.com/Check-Data-Out/velog-dashboard-v2-api/blob/main/src/configs/logger.config.ts"
    click SwaggerConfig "https://github.com/Check-Data-Out/velog-dashboard-v2-api/blob/main/src/configs/swagger.config.ts"
    click TokenEncrypt "https://github.com/Check-Data-Out/velog-dashboard-v2-api/blob/main/src/modules/token_encryption/aes_encryption.ts"
    click Post "https://github.com/Check-Data-Out/velog-dashboard-v2-api/blob/main/src/types/models/Post.type.ts"
    click User "https://github.com/Check-Data-Out/velog-dashboard-v2-api/blob/main/src/types/models/User.type.ts"
    click PostStats "https://github.com/Check-Data-Out/velog-dashboard-v2-api/blob/main/src/types/models/PostStatistics.type.ts"
    click DailyStats "https://github.com/Check-Data-Out/velog-dashboard-v2-api/blob/main/src/types/models/PostDailyStatistics.type.ts"
    click PageVisits "https://github.com/Check-Data-Out/velog-dashboard-v2-api/blob/main/src/types/models/PageVisits.type.ts"
    click EventTrack "https://github.com/Check-Data-Out/velog-dashboard-v2-api/blob/main/src/types/models/UserEventTracking.type.ts"
    click PostRouter "https://github.com/Check-Data-Out/velog-dashboard-v2-api/blob/main/src/routes/post.router.ts"
    click UserRouter "https://github.com/Check-Data-Out/velog-dashboard-v2-api/blob/main/src/routes/user.router.ts"
    click TrackRouter "https://github.com/Check-Data-Out/velog-dashboard-v2-api/blob/main/src/routes/tracking.router.ts"
    click CustomExcept "https://github.com/Check-Data-Out/velog-dashboard-v2-api/blob/main/src/exception/custom.exception.ts"
    click DBExcept "https://github.com/Check-Data-Out/velog-dashboard-v2-api/blob/main/src/exception/db.exception.ts"
    click AuthExcept "https://github.com/Check-Data-Out/velog-dashboard-v2-api/blob/main/src/exception/unauthorized.exception.ts"
    click ReqExcept "https://github.com/Check-Data-Out/velog-dashboard-v2-api/blob/main/src/exception/badRequest.exception.ts"
```
