# aleksandrsherehkov/snake-backend architecture

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

- Interactive diagram: https://gitdiagram.com/aleksandrsherehkov/snake-backend
- Repository: https://github.com/aleksandrsherehkov/snake-backend

## Overview

##### Project type and purpose
- This is a single‐service, backend REST API (“Score API”) written in Node.js/Express with TypeScript.
- It exposes CRUD endpoints for game scores, validates input, logs requests, secures HTTP headers, and persists data in a relational database via Prisma.

##### File structure
- Top-level: configuration (.env.example, tsconfig.json, package.json), database schema/migrations (prisma/), Swagger spec (swagger.json), source code (src/).
- Under src/:
- controllers: HTTP handlers (ping.controller.ts, score.controller.ts)
- routes: Express routers (score.routes.ts)
- services: business logic (ping.service.ts, score.service.ts)
- middlewares: logging, error handling, validation
- validations: Joi schemas
- utils: shared helper classes (HttpError, logger, tryCatch)
- index.ts: app initialization, middleware wiring, server start

##### README for additional insights
- Confirms tech stack: Express, TypeScript, Prisma, Joi, Helmet, Morgan, Winston, CORS, Swagger-UI.
- Describes endpoints (/api/scores, /api/check-unique-name, /api/ping).
- Shows database migration steps and usage.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% External Clients
    Client["API Consumer\n(Game UI, Postman)"]:::external

    %% API Gateway Layer
    subgraph "API Gateway (Express + Global Middleware)"
        direction TB
        Express["Express App"]:::api
        CORS["CORS"]:::security
        Helmet["Helmet"]:::security
        Morgan["Morgan"]:::logging
        ValidationMW["Validation Middleware"]:::utility
        ErrorMW["Error Middleware"]:::utility
        SwaggerUI["Swagger UI\n(/api-docs)"]:::utility
    end

    %% Routing & Controllers Layer
    subgraph "Routing & Controllers"
        direction TB
        Routes["Score Routes"]:::api
        PingCtrl["Ping Controller"]:::api
        ScoreCtrl["Score Controller"]:::api
    end

    %% Business Logic Layer
    subgraph "Business Logic (Services)"
        direction TB
        PingSvc["Ping Service"]:::service
        ScoreSvc["Score Service"]:::service
    end

    %% Utilities Layer
    subgraph "Utilities"
        direction TB
        HttpError["HttpError"]:::utility
        LoggerUtil["Logger"]:::utility
        TryCatch["tryCatch Wrapper"]:::utility
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        PrismaClient["Prisma Client"]:::data
        DB["Database\n(PostgreSQL)"]:::external
        Schema["schema.prisma"]:::data
        Migration1["20240705091617_init"]:::data
        Migration2["20240705202851_add_unique_constraint_to_name"]:::data
    end

    %% Logging Subsystem
    subgraph "Logging Subsystem"
        direction TB
        Winston["Winston"]:::logging
    end

    %% Flows
    Client -->|HTTP Request| Express
    Express -->|use| CORS
    CORS -->|use| Helmet
    Helmet -->|use| Morgan
    Morgan -->|use| ValidationMW
    ValidationMW -->|validate| Routes
    Express -->|serve static| SwaggerUI
    Routes -->|route to| PingCtrl
    Routes -->|route to| ScoreCtrl
    PingCtrl -->|wrap| TryCatch
    ScoreCtrl -->|wrap| TryCatch
    TryCatch -->|calls| PingSvc
    TryCatch -->|calls| ScoreSvc
    ScoreSvc -->|query/mutate| PrismaClient
    PrismaClient -->|SQL| DB
    PrismaClient -->|reads schema| Schema
    PrismaClient -->|runs| Migration1
    PrismaClient -->|runs| Migration2
    Morgan -->|logs| Winston
    PingCtrl -->|error| HttpError
    ScoreCtrl -->|error| HttpError
    HttpError -->|handled by| ErrorMW

    %% Click Events
    click Express "https://github.com/aleksandrsherehkov/snake-backend/blob/main/src/index.ts"
    click ValidationMW "https://github.com/aleksandrsherehkov/snake-backend/blob/main/src/middlewares/validation.middleware.ts"
    click ErrorMW "https://github.com/aleksandrsherehkov/snake-backend/blob/main/src/middlewares/error.middleware.ts"
    click Routes "https://github.com/aleksandrsherehkov/snake-backend/blob/main/src/routes/score.routes.ts"
    click PingCtrl "https://github.com/aleksandrsherehkov/snake-backend/blob/main/src/controllers/ping.controller.ts"
    click ScoreCtrl "https://github.com/aleksandrsherehkov/snake-backend/blob/main/src/controllers/score.controller.ts"
    click PingSvc "https://github.com/aleksandrsherehkov/snake-backend/blob/main/src/services/ping.service.ts"
    click ScoreSvc "https://github.com/aleksandrsherehkov/snake-backend/blob/main/src/services/score.service.ts"
    click HttpError "https://github.com/aleksandrsherehkov/snake-backend/blob/main/src/utils/HttpError.ts"
    click LoggerUtil "https://github.com/aleksandrsherehkov/snake-backend/blob/main/src/utils/logger.ts"
    click TryCatch "https://github.com/aleksandrsherehkov/snake-backend/blob/main/src/utils/tryCatch.ts"
    click Schema "https://github.com/aleksandrsherehkov/snake-backend/blob/main/prisma/schema.prisma"
    click Migration1 "https://github.com/aleksandrsherehkov/snake-backend/blob/main/prisma/migrations/20240705091617_init/migration.sql"
    click Migration2 "https://github.com/aleksandrsherehkov/snake-backend/blob/main/prisma/migrations/20240705202851_add_unique_constraint_to_name/migration.sql"
    click SwaggerUI "https://github.com/aleksandrsherehkov/snake-backend/blob/main/swagger.json"

    %% Styles
    classDef external fill:#f0f0f0,stroke:#333
    classDef api fill:#cce5ff,stroke:#0366d6
    classDef service fill:#d4edda,stroke:#216e34
    classDef data fill:#ffe5b4,stroke:#d39e00
    classDef utility fill:#fff3cd,stroke:#826500
    classDef logging fill:#e3d4f5,stroke:#6f42c1
    classDef security fill:#e8f5e9,stroke:#256029
```
