# z1ngod/myfin-back-end architecture

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

- Interactive diagram: https://gitdiagram.com/z1ngod/myfin-back-end
- Repository: https://github.com/z1ngod/myfin-back-end

## Overview

##### Project type and purpose
- This is a backend API built with NestJS (TypeScript).
- Purpose: provide endpoints for “MyFin” expense management app—handling authentication, budgets, expenses, and user data.
- Monolithic, modular design: divided into core feature modules and shared “libs.”

##### File structure
- Top‑level:
– src/app.module.ts – Nest root module
– src/main.ts – entry point
– src/core – feature modules (auth, budgets, expenses, user)
– src/libs – shared modules (db, cache, redis, security)
- Each feature module contains: controllers, DTOs, services, tests.
- Shared “libs/db” uses schemas and repositories (Mongoose), migrations and seed scripts.
- “libs/redis” provides a caching module and service.
- “libs/security” contains guards, strategies, and token/password services.
- Config and environment validation under src/common.
- CI/CD workflows, linting, commit hooks, and release configs in root.

##### Key architectural insights from README
- Backend API only (no UI).
- NestJS modular architecture—emphasis on separation of concerns.
- Integrates with a MongoDB (via Mongoose schemas + migrations) and Redis for caching.
- JWT‑based auth (access & refresh token strategies).

##### Components & interactions
a. Main components:
1. Client (MyFin App or Postman)
2. API Gateway (NestJS application)
3. Feature Modules:
– Auth Module (login, token refresh)
– Budgets Module
– Expenses Module
– Users Module
4. Shared Modules:
– DB Module (Mongoose connection, repositories)
– Redis Cache Module
– Security Module (Guards, JWT strategies)
5. External Systems:
– MongoDB database
– Redis server

b. Relationships / Data Flow:
1. Client → HTTP request → NestJS Controllers (for each feature)
2. Controller → Service → (optional) Redis Cache lookup/write
3. If cache miss or non-cacheable: Service → Repository → MongoDB
4. Repository → returns data → Service (business logic) → Controller → HTTP response
5. Auth flows: Controller uses Security Guards → TokenService → issues/verifies JWT
6. Common Env & Config provider injects settings into all modules

c. Architectural patterns / design principles:
- Layered architecture: Controllers → Services → Repositories → DB
- Modular structure: each feature in its own Nest module
- Shared libraries for cross‑cutting concerns (cache, security, DB)
- Dependency injection via NestJS modules
- Separation of config (env validation, constants) from code

d. Relevant technologies / frameworks:
– NestJS (module-based DI)
– TypeScript
– Mongoose (schema definitions, migrations, seeders)
– Redis (caching)
– JWT (via passport strategies in security module)
– Testing: Jest (unit + e2e)

## Diagram (Mermaid)

```mermaid
flowchart TD
    classDef feature fill:#E8F1FA,stroke:#1E70BF,color:#000
    classDef shared fill:#E8F9F0,stroke:#27632a,color:#000
    classDef external fill:#EDEDED,stroke:#999,color:#000

    Client["MyFin App / Postman"]:::external
    main["NestJS Entry Point<br>main.ts"]:::shared
    appModule["AppModule<br>app.module.ts"]:::shared

    Client -->|"HTTP Request"| main -->|"Bootstrap"| appModule

    subgraph "NestJS Application"
        subgraph "Feature Modules"
            subgraph AuthModule
                authC["AuthController"]:::feature
                authS["AuthService"]:::feature
            end
            subgraph BudgetsModule
                budgC["BudgetsController"]:::feature
                budgS["BudgetsService"]:::feature
            end
            subgraph ExpensesModule
                expC["ExpensesController"]:::feature
                expS["ExpensesService"]:::feature
            end
            subgraph UsersModule
                userC["UsersController"]:::feature
                userS["UsersService"]:::feature
            end
        end
        subgraph "Shared Libraries"
            dbMod["DB Module"]:::shared
            redisMod["Redis Cache Module"]:::shared
            secMod["Security Module"]:::shared
            config["Config & Env Validation"]:::shared
        end
    end

    appModule -->|imports| AuthModule
    appModule -->|imports| BudgetsModule
    appModule -->|imports| ExpensesModule
    appModule -->|imports| UsersModule
    appModule -->|imports| dbMod
    appModule -->|imports| redisMod
    appModule -->|imports| secMod
    appModule -->|imports| config

    AuthModule --> authC
    authC --> authS
    authS --> redisMod
    authS --> dbMod
    authC -->|uses Guards/Strategies| secMod

    BudgetsModule --> budgC
    budgC --> budgS
    budgS --> redisMod
    budgS --> dbMod

    ExpensesModule --> expC
    expC --> expS
    expS --> redisMod
    expS --> dbMod

    UsersModule --> userC
    userC --> userS
    userS --> redisMod
    userS --> dbMod

    redisMod -->|"cache lookup/write"| Redis["Redis Server"]:::external
    dbMod -->|"reads/writes"| Mongo["MongoDB"]:::external

    click main "https://github.com/z1ngod/myfin-back-end/blob/main/src/main.ts"
    click appModule "https://github.com/z1ngod/myfin-back-end/blob/main/src/app.module.ts"
    click AuthModule "https://github.com/z1ngod/myfin-back-end/blob/main/src/core/auth/auth.module.ts"
    click authC "https://github.com/z1ngod/myfin-back-end/blob/main/src/core/auth/controllers/auth.controller.ts"
    click authS "https://github.com/z1ngod/myfin-back-end/blob/main/src/core/auth/services/auth.service.ts"
    click BudgetsModule "https://github.com/z1ngod/myfin-back-end/blob/main/src/core/budgets/budgets.module.ts"
    click budgC "https://github.com/z1ngod/myfin-back-end/blob/main/src/core/budgets/controllers/budgets.controller.ts"
    click budgS "https://github.com/z1ngod/myfin-back-end/blob/main/src/core/budgets/services/budgets.service.ts"
    click ExpensesModule "https://github.com/z1ngod/myfin-back-end/blob/main/src/core/expences/expenses.module.ts"
    click expC "https://github.com/z1ngod/myfin-back-end/blob/main/src/core/expences/controllers/expenses.controller.ts"
    click expS "https://github.com/z1ngod/myfin-back-end/blob/main/src/core/expences/services/expenses.service.ts"
    click UsersModule "https://github.com/z1ngod/myfin-back-end/blob/main/src/core/user/user.module.ts"
    click userC "https://github.com/z1ngod/myfin-back-end/blob/main/src/core/user/controllers/user.controller.ts"
    click userS "https://github.com/z1ngod/myfin-back-end/blob/main/src/core/user/services/user.service.ts"
    click dbMod "https://github.com/z1ngod/myfin-back-end/blob/main/src/libs/db/db.module.ts"
    click redisMod "https://github.com/z1ngod/myfin-back-end/blob/main/src/libs/redis/redis.module.ts"
    click secMod "https://github.com/z1ngod/myfin-back-end/blob/main/src/libs/security/security.module.ts"
    click config "https://github.com/z1ngod/myfin-back-end/blob/main/src/common/envValidation/env.validation.ts"
```
