# dreamsparkx/node-ts-starter architecture

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

- Interactive diagram: https://gitdiagram.com/dreamsparkx/node-ts-starter
- Repository: https://github.com/dreamsparkx/node-ts-starter

## Overview

##### Main Components

A. Client Layer
- Web Browser/Client Applications
- Static Assets (CSS, JavaScript, Images)
- Views (Pug Templates)

B. Application Layer
- Express.js Server
- Middleware Stack
- Controllers
- Routes
- Authentication System

C. Data Layer
- MongoDB Database
- User Model

D. Utility Services
- Logger (Winston)
- JWT Service
- Swagger/ReDoc Documentation

##### Component Relationships

**[Client] → [Express Server] → [MongoDB]**
- ↑
- [Utility Services]

##### Detailed Component Breakdown

A. Client Layer (Top):
- Static assets (/public folder) with subcomponents:
- CSS (main.scss)
- JavaScript (main.ts)
- Images
- Fonts

B. Application Layer (Middle):
- Express Server (src/app.ts)
- Middleware Stack (show as a vertical pipeline):
- Authentication Middleware
- Error Handling
- Winston Logging
- Controllers Layer:
- Home Controller
- User Controller
- Routes Layer:
- API Routes
- User Routes
- Documentation Routes

C. Data Layer (Bottom):
- MongoDB Database
- User Model (show schema structure)

D. Utility Services (Side):
- JWT Service
- Logger Service
- Swagger Documentation
- Secrets Management

##### Important Elements to Highlight

- Authentication flow
- API documentation endpoints
- Error handling pipeline
- Logging system
- Static asset serving
- Template rendering

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Client
        Browser["Web Browser"]
        StaticAssets["Static Assets"]
        Views["View Templates"]:::views
        
        subgraph Assets
            CSS["CSS (main.scss)"]:::css
            JS["JavaScript (main.ts)"]:::js
            Images["Images"]:::images
            Fonts["Fonts"]:::fonts
        end
        
        Browser --> StaticAssets
        StaticAssets --> Assets
        Browser --> Views
    end

    subgraph Server
        Express["Express Server"]:::express
        
        subgraph Middleware
            Auth["Authentication"]:::middleware
            ErrorHandler["Error Handling"]:::middleware
            Logger["Winston Logger"]:::middleware
        end
        
        subgraph Controllers
            HomeCtrl["Home Controller"]:::controller
            UserCtrl["User Controller"]:::controller
        end
        
        subgraph Routes
            APIRoutes["API Routes"]:::route
            UserRoutes["User Routes"]:::route
            DocRoutes["Documentation Routes"]:::route
        end
        
        Express --> Middleware
        Middleware --> Controllers
        Controllers --> Routes
    end

    subgraph Database
        MongoDB[(MongoDB)]
        UserModel["User Model"]:::model
        MongoDB --> UserModel
    end

    subgraph Utilities
        JWTService["JWT Service"]:::util
        LogService["Logger Service"]:::util
        SwaggerDoc["Swagger Documentation"]:::util
        Secrets["Secrets Management"]:::util
        ErrorUtil["Error Utilities"]:::util
    end

    Browser --> Express
    Routes --> MongoDB
    Server --> Utilities

    %% Click Events
    click Express "https://github.com/dreamsparkx/node-ts-starter/blob/master/src/app.ts"
    click HomeCtrl "https://github.com/dreamsparkx/node-ts-starter/blob/master/src/controllers/home.ts"
    click UserCtrl "https://github.com/dreamsparkx/node-ts-starter/blob/master/src/controllers/user/index.ts"
    click APIRoutes "https://github.com/dreamsparkx/node-ts-starter/blob/master/src/routes/api.ts"
    click UserRoutes "https://github.com/dreamsparkx/node-ts-starter/blob/master/src/routes/user.ts"
    click DocRoutes "https://github.com/dreamsparkx/node-ts-starter/blob/master/src/routes/docs.ts"
    click Auth "https://github.com/dreamsparkx/node-ts-starter/blob/master/src/middlewares/authenticate.ts"
    click ErrorHandler "https://github.com/dreamsparkx/node-ts-starter/blob/master/src/middlewares/error.ts"
    click Logger "https://github.com/dreamsparkx/node-ts-starter/blob/master/src/middlewares/winston.ts"
    click UserModel "https://github.com/dreamsparkx/node-ts-starter/blob/master/src/models/User.ts"
    click LogService "https://github.com/dreamsparkx/node-ts-starter/blob/master/src/util/logger.ts"
    click JWTService "https://github.com/dreamsparkx/node-ts-starter/blob/master/src/util/jwt.ts"
    click SwaggerDoc "https://github.com/dreamsparkx/node-ts-starter/blob/master/src/util/swagger.ts"
    click Secrets "https://github.com/dreamsparkx/node-ts-starter/blob/master/src/util/secrets.ts"
    click ErrorUtil "https://github.com/dreamsparkx/node-ts-starter/blob/master/src/util/error.ts"
    click CSS "https://github.com/dreamsparkx/node-ts-starter/blob/master/src/public/css/main.scss"
    click JS "https://github.com/dreamsparkx/node-ts-starter/blob/master/src/public/js/main.ts"
    click Fonts "https://github.com/dreamsparkx/node-ts-starter/tree/master/src/public/fonts"
    click Images "https://github.com/dreamsparkx/node-ts-starter/tree/master/src/public/images"
    click Views "https://github.com/dreamsparkx/node-ts-starter/tree/master/views"

    %% Styling
    classDef express fill:#2ecc71
    classDef middleware fill:#f1c40f
    classDef controller fill:#3498db
    classDef route fill:#e74c3c
    classDef model fill:#9b59b6
    classDef util fill:#e67e22
    classDef views fill:#1abc9c
    classDef css fill:#95a5a6
    classDef js fill:#34495e
    classDef images fill:#7f8c8d
    classDef fonts fill:#95a5a6
```
