# mdozairq/ott-platform architecture

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

- Interactive diagram: https://gitdiagram.com/mdozairq/ott-platform
- Repository: https://github.com/mdozairq/ott-platform

## Overview

##### Project type and purpose
- This is a backend‐only monolithic service (“OTT Platform”) built with Nest.JS (TypeScript) exposing REST endpoints, persisting data in MongoDB, and packaged/deployed via Docker Compose. There is no frontend in this repo; clients interact over HTTP (e.g., Swagger UI or mobile/web apps).

##### High‐level components
a. External clients (API consumers, Swagger UI)
b. Load Balancer / API Gateway (optional)
c. Docker Compose orchestration
- NestJS application container
- MongoDB container
d. Nest Application (one container)
- Config Module (env & secrets)
- Common Module (response interceptor)
- Health Module (liveness/health check)
- JWT Module (token generation & validation)
- Role Module (guards & decorators)
- Users Module
- Movies Module
- TV Shows Module
- My-List Module
- Error Handling Module
e. Persistence Layer
- MongoDB (collections: users, movies, tvshows, myLists)
f. External or future services (e.g., Payment, Caching, Message Queues)

##### Interactions & data flow
- Client → (LB/Gateway) → NestJS Controller
- Controller → Service → Repository (Data Access)
- Repository → MongoDB (CRUD)
- JWT Module issues/verifies tokens on protected endpoints
- Role Module enforces RBAC guards in controllers
- Health Module returns ✔/✖ for liveness probes
- Docker Compose links NestJS & MongoDB via network

##### Architectural patterns & design principles
- Layered (Controller → Service → Repository)
- Modular (NestJS Modules per domain)
- Dependency Injection (built-in NestJS DI container)
- Cross-cutting concerns in dedicated modules (Config, Common/Interceptor, Errors, JWT, Role)
- Future extensibility via new modules or microservice extraction

##### Technologies & frameworks
- NestJS (TypeScript)
- MongoDB (NoSQL)
- Docker & Docker Compose
- Swagger (OpenAPI auto-docs)
- Jest (e2e & unit tests)
- ESLint/Prettier (code quality)
- Migrations (seed JSON files)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Context Diagram
    subgraph "Context"
        direction TB
        Client["External Clients (API Consumers, Swagger UI)"]:::external
        LB["Load Balancer / API Gateway"]:::infra
        OTT["OTT Platform"]:::app
        MongoDB["MongoDB"]:::db
    end

    Client -->|HTTP Requests| LB
    LB -->|Forwards Requests| OTT
    OTT -->|CRUD Operations| MongoDB

    %% Container Diagram
    subgraph "Docker Compose"
        direction TB
        AppContainer["NestJS App Container<br/>(Port 3000)"]:::app
        DBContainer["MongoDB Container<br/>(Port 27017)"]:::db
    end

    OTT --> AppContainer
    AppContainer -->|Network Link| DBContainer
    DBContainer --> MongoDB

    click AppContainer "https://github.com/mdozairq/ott-platform/blob/main/docker-compose.yml"
    click DBContainer "https://github.com/mdozairq/ott-platform/blob/main/docker-compose.yml"

    %% Component Diagram (Inside App Container)
    subgraph "App Container (NestJS Modules)"
        direction TB
        Config["Config Module"]:::module
        Common["Common Module"]:::module
        Health["Health Module"]:::module
        JWT["JWT Module"]:::module
        Role["Role Module"]:::module
        Users["Users Module"]:::module
        Movies["Movies Module"]:::module
        TVShows["TV Shows Module"]:::module
        MyList["My-List Module"]:::module
        Errors["Error Handling Module"]:::module
    end

    %% Cross-cutting flows
    Config -->|Provides Env & Secrets| Users
    Config -->|Provides Env & Secrets| Movies
    Config -->|Provides Env & Secrets| TVShows
    Config -->|Provides Env & Secrets| MyList
    Config -->|Provides Env & Secrets| Health
    Config -->|Provides Env & Secrets| JWT
    Config -->|Provides Env & Secrets| Role
    Config -->|Provides Env & Secrets| Errors
    Common -->|Interceptors/Decorators| Users
    Common -->|Interceptors/Decorators| Movies
    Common -->|Interceptors/Decorators| TVShows
    Common -->|Interceptors/Decorators| MyList

    %% Auth & RBAC flows
    JWT -->|Issue/Verify Tokens| Users
    JWT -->|Issue/Verify Tokens| Movies
    JWT -->|Issue/Verify Tokens| TVShows
    JWT -->|Issue/Verify Tokens| MyList
    Role -->|Enforce Guards| Users
    Role -->|Enforce Guards| Movies
    Role -->|Enforce Guards| TVShows
    Role -->|Enforce Guards| MyList

    %% Health checks
    Health -->|Liveness/Readiness| LB

    %% Domain flows
    Users -->|Service→Repository| MongoDB
    Movies -->|Service→Repository| MongoDB
    TVShows -->|Service→Repository| MongoDB
    MyList -->|Service→Repository| MongoDB

    %% Entry point
    Main["Application Entry<br/>& Root Module"]:::module
    Main --> Config
    Main --> Common
    Main --> Health
    Main --> JWT
    Main --> Role
    Main --> Users
    Main --> Movies
    Main --> TVShows
    Main --> MyList
    Main --> Errors

    click Config "https://github.com/mdozairq/ott-platform/blob/main/src/config/config.module.ts"
    click Common "https://github.com/mdozairq/ott-platform/blob/main/src/common/response.interceptor.ts"
    click Health "https://github.com/mdozairq/ott-platform/blob/main/src/health/health.module.ts"
    click JWT "https://github.com/mdozairq/ott-platform/blob/main/src/jwt/auth.jwt.ts"
    click Role "https://github.com/mdozairq/ott-platform/blob/main/src/role/role-guard.ts"
    click Users "https://github.com/mdozairq/ott-platform/blob/main/src/users/users.module.ts"
    click Movies "https://github.com/mdozairq/ott-platform/blob/main/src/movies/movies.module.ts"
    click TVShows "https://github.com/mdozairq/ott-platform/blob/main/src/tv-shows/tv-shows.module.ts"
    click MyList "https://github.com/mdozairq/ott-platform/blob/main/src/my-list/my-list.module.ts"
    click Errors "https://github.com/mdozairq/ott-platform/blob/main/src/errors/custom.errors.ts"
    click Main "https://github.com/mdozairq/ott-platform/blob/main/src/app.module.ts"

    %% Styles
    classDef external fill:#f2f2f2,stroke:#333,stroke-width:1px
    classDef infra fill:#bbdefb,stroke:#1e88e5,stroke-width:2px
    classDef app fill:#e1bee7,stroke:#8e24aa,stroke-width:2px
    classDef db fill:#c8e6c9,stroke:#388e3c,stroke-width:2px,shape:cylinder
    classDef module fill:#fff9c4,stroke:#f9a825,stroke-width:1px
```
