# briangor/movie-recommendation-server architecture

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

- Interactive diagram: https://gitdiagram.com/briangor/movie-recommendation-server
- Repository: https://github.com/briangor/movie-recommendation-server

## Overview

##### Project Type and Purpose
- This is a backend-only, full-stack application’s API layer (no frontend code in this repo).
- Purpose: expose a RESTful Movie Recommendation Server built on Node.js, Express and MySQL, handling movies and genres.

##### File Structure & Architectural Patterns
- src/index.ts: boots the Express server, loads middleware and routes.
- src/config/db.config.ts: holds DB connection parameters.
- src/database.js: sets up the actual connection (e.g., Sequelize or mysql2).
- src/routes/*.ts: Express routers defining HTTP endpoints by resource (movie, genre).
- src/controllers/*.ts: business logic—take request params, invoke model methods, send responses.
- src/models/*.ts: define ORM models (db.model.ts for init, movie.model.ts, genre.model.ts).
- src/utils/helper.ts: shared utility functions.
- This follows a classic layered (Router → Controller → Model → Database) architecture.

##### Key Components
a. External Clients
- API consumer (web app, mobile app, automated scripts).
b. Express Application
- index.ts (entry point)
- Configuration layer (db.config.ts)
- Routing layer (movie.routes.ts, genre.routes.ts)
- Controller layer (movie.controller.ts, genre.controller.ts)
- Model/ORM layer (db.model.ts sets up ORM, movie.model.ts, genre.model.ts)
- Utilities (helper.ts)
c. Database
- MySQL server (with movies and genres tables)

##### Relationships & Data Flow
1. Client → HTTP Request → Express server (index.ts).
2. Express → Routing layer (router matches `/movies`, `/genres`).
3. Router → Controller (e.g., movie.controller.findAll()).
4. Controller → Model methods (e.g., Movie.findAll(), Genre.create()).
5. Model → MySQL (via Sequelize/mysql2).
6. MySQL response → Model → Controller → Express → Client.
7. Config (db.config.ts) injected into DB layer; utilities available anywhere.

##### Architectural Patterns & Design Principles
- Layered architecture (Presentation/Routes, Business/Controllers, Data/Models).
- Single Responsibility per module.
- Configuration separated from code.
- Utility functions extracted to avoid duplication.

##### Technologies & Frameworks
- Node.js + Express (web framework)
- TypeScript (static typing)
- MySQL (relational database)
- ORM (likely Sequelize or mysql2)
- nodemon for live reloading (nodemon.json)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Client
    Client["External Client"]:::external

    %% Entry Point & Configurations
    Index["index.ts"]:::entry
    DBConfig["db.config.ts"]:::config
    Nodemon["nodemon.json"]:::config

    %% Database Setup
    DatabaseJS["database.js"]:::dbsetup

    %% Utilities
    Utils["helper.ts"]:::utils

    %% Routing Layer
    subgraph "Routing Layer"
        direction TB
        MovieRoutes["movie.routes.ts"]:::route
        GenreRoutes["genre.routes.ts"]:::route
    end

    %% Controller Layer
    subgraph "Controller Layer"
        direction TB
        MovieController["movie.controller.ts"]:::controller
        GenreController["genre.controller.ts"]:::controller
    end

    %% Model/ORM Layer
    subgraph "Model/ORM Layer"
        direction TB
        DBModel["db.model.ts"]:::model
        MovieModel["movie.model.ts"]:::model
        GenreModel["genre.model.ts"]:::model
        Sequelize["Sequelize ORM"]:::model
    end

    %% Database
    DB[(MySQL Database)]:::database

    %% Data Flow - Requests
    Client -->|"HTTP Request"| Index
    Index -->|"uses"| DBConfig
    Index -->|"uses"| DatabaseJS
    Index -->|"live reload"| Nodemon
    Index -->|"routes to"| MovieRoutes
    Index -->|"routes to"| GenreRoutes

    MovieRoutes -->|"calls"| MovieController
    GenreRoutes -->|"calls"| GenreController

    MovieController -->|"uses"| Utils
    GenreController -->|"uses"| Utils
    MovieController -->|"calls"| MovieModel
    GenreController -->|"calls"| GenreModel

    MovieModel -->|"initialized by"| DBModel
    GenreModel -->|"initialized by"| DBModel
    DBModel -->|"uses"| DatabaseJS
    DBModel -->|"via ORM"| Sequelize
    Sequelize -->|"connects to"| DB

    %% Return Path
    DB -->|"response"| Sequelize
    Sequelize -->|"response"| DBModel
    DBModel -->|"response"| MovieModel
    MovieModel -->|"data"| MovieController
    MovieController -->|"response"| MovieRoutes
    MovieRoutes -->|"response"| Index
    Index -->|"HTTP Response"| Client

    %% Click Events
    click Client "https://github.com/briangor/movie-recommendation-server/tree/main/External Clients"
    click Index "https://github.com/briangor/movie-recommendation-server/blob/main/src/index.ts"
    click DBConfig "https://github.com/briangor/movie-recommendation-server/blob/main/src/config/db.config.ts"
    click Nodemon "https://github.com/briangor/movie-recommendation-server/blob/main/nodemon.json"
    click DatabaseJS "https://github.com/briangor/movie-recommendation-server/blob/main/src/database.js"
    click Utils "https://github.com/briangor/movie-recommendation-server/blob/main/src/utils/helper.ts"
    click MovieRoutes "https://github.com/briangor/movie-recommendation-server/blob/main/src/routes/movie.routes.ts"
    click GenreRoutes "https://github.com/briangor/movie-recommendation-server/blob/main/src/routes/genre.routes.ts"
    click MovieController "https://github.com/briangor/movie-recommendation-server/blob/main/src/controllers/movie.controller.ts"
    click GenreController "https://github.com/briangor/movie-recommendation-server/blob/main/src/controllers/genre.controller.ts"
    click DBModel "https://github.com/briangor/movie-recommendation-server/blob/main/src/models/db.model.ts"
    click MovieModel "https://github.com/briangor/movie-recommendation-server/blob/main/src/models/movie.model.ts"
    click GenreModel "https://github.com/briangor/movie-recommendation-server/blob/main/src/models/genre.model.ts"

    %% Styles
    classDef external fill:#f0f0f0,stroke:#333;
    classDef entry fill:#cce5ff,stroke:#333;
    classDef config fill:#fff3cd,stroke:#333;
    classDef dbsetup fill:#fff3cd,stroke:#333;
    classDef utils fill:#fff3cd,stroke:#333;
    classDef route fill:#cce5ff,stroke:#333;
    classDef controller fill:#d4edda,stroke:#333;
    classDef model fill:#ffe5b4,stroke:#333;
    classDef database fill:#e0e0e0,stroke:#333;
```
