# olszarai/labelapp_backend architecture

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

- Interactive diagram: https://gitdiagram.com/olszarai/labelapp_backend
- Repository: https://github.com/olszarai/labelapp_backend

## Overview

##### Project type and purpose
- This is a monolithic backend RESTful API for “LabelApp” built with Node.js, Express.js, and TypeScript.
- Its purpose is to manage users, projects, and labels, exposing endpoints for registration, login, CRUD operations, and password reset.

##### File structure
- Top-level directories:
- prisma/ → database schema and migration scripts
- src/controllers/ → business logic per resource (User, Project, Label)
- src/routes/ → HTTP endpoint definitions
- src/middleware/ → JWT authentication middleware
- src/generated/prisma/ → auto-generated Prisma Client
- src/index.ts → Express server bootstrap
- Patterns:
- MVC: Models (Prisma schema), Views (not applicable – it’s an API), Controllers
- API routing layer → middleware → controllers → ORM client → database
- Config files: tsconfig.json, package.json, .gitignore

##### Extract architecture details from README
- MVC layers, Prisma ORM, JWT auth with HttpOnly cookies, bcrypt password hashing, nodemailer for email, PostgreSQL database
- Endpoints grouped by resource

##### Main components and their relationships
a. Clients
- Frontend or other API consumers
b. API Layer (Express Server)
1. Routing module (src/routes)
2. Middleware (src/middleware/authMiddleware.ts)
3. Controllers (src/controllers/*.ts)
4. Prisma Client (src/generated/prisma)
c. Database
- PostgreSQL with schema defined in prisma/schema.prisma
d. External Services
- SMTP server (nodemailer) for password reset emails
e. Environment & Config
- .env variables for DB, JWT secret, email credentials

##### Interaction flow
1. Client → HTTP Request → Express route
2. Route → authMiddleware (if protected)
3. Middleware → Controller
4. Controller → Prisma Client → PostgreSQL
5. Controller → Optional external call (SMTP) → nodemailer
6. Controller → Response → Client

##### Architectural patterns & design principles
- Layered MVC separation
- Dependency injection of Prisma client into controllers (via imports)
- Stateless JWT-based authentication
- Secure cookie storage (HttpOnly, SameSite)
- Migration-based schema evolution (Prisma migrations)

##### Detail-level checklist
- Prisma/schema.prisma as source of truth for data model
- JWT creation/verification step inside Middleware
- Environment variables driving DB connection and JWT secret

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Clients
    Client["API Consumer"]:::external

    %% Express Server
    subgraph "Express.js HTTP Server"
        direction TB
        server["Express Bootstrap"]:::compute
        subgraph "Routing Layer"
            direction TB
            userRoutes["User Routes"]:::compute
            projectRoutes["Project Routes"]:::compute
            labelRoutes["Label Routes"]:::compute
        end
        authMiddleware["Auth Middleware (JWT)"]:::compute
        subgraph "Controllers"
            direction TB
            userController["User Controller"]:::compute
            projectController["Project Controller"]:::compute
            labelController["Label Controller"]:::compute
        end
        prismaClient["Prisma Client"]:::compute
    end

    %% Database and Schema
    prismaSchema["Prisma Schema"]:::artifact
    prismaMigrations["Prisma Migrations"]:::artifact
    DB["PostgreSQL"]:::database

    %% External Services
    SMTP["SMTP Service"]:::external

    %% Config Artifacts
    tsconfig["tsconfig.json"]:::artifact
    package["package.json"]:::artifact
    gitignore[".gitignore"]:::artifact

    %% Environment Variables
    Env[".env Variables"]:::artifact

    %% Data Flows
    Client -->|"HTTP Request"| server
    server -->|"routes to"| userRoutes
    server -->|"routes to"| projectRoutes
    server -->|"routes to"| labelRoutes
    userRoutes -->|"protected"| authMiddleware
    projectRoutes -->|"protected"| authMiddleware
    labelRoutes -->|"protected"| authMiddleware
    authMiddleware -->|"calls"| userController
    authMiddleware -->|"calls"| projectController
    authMiddleware -->|"calls"| labelController
    userController -->|"queries"| prismaClient
    projectController -->|"queries"| prismaClient
    labelController -->|"queries"| prismaClient
    prismaClient -->|"reads/writes"| DB
    userController -->|"sends email"| SMTP

    prismaSchema -->|"defines schema"| DB
    prismaMigrations -->|"migrations"| DB

    Env --> server

    tsconfig --> server
    package --> server
    gitignore --> server

    %% Click Events
    click prismaSchema "https://github.com/olszarai/labelapp_backend/blob/main/prisma/schema.prisma"
    click prismaMigrations "https://github.com/olszarai/labelapp_backend/tree/main/prisma/migrations/"
    click server "https://github.com/olszarai/labelapp_backend/blob/main/src/index.ts"
    click userRoutes "https://github.com/olszarai/labelapp_backend/blob/main/src/routes/userRoutes.ts"
    click projectRoutes "https://github.com/olszarai/labelapp_backend/blob/main/src/routes/projectRoutes.ts"
    click labelRoutes "https://github.com/olszarai/labelapp_backend/blob/main/src/routes/labelRoutes.ts"
    click authMiddleware "https://github.com/olszarai/labelapp_backend/blob/main/src/middleware/authMiddleware.ts"
    click userController "https://github.com/olszarai/labelapp_backend/blob/main/src/controllers/userController.ts"
    click projectController "https://github.com/olszarai/labelapp_backend/blob/main/src/controllers/projectController.ts"
    click labelController "https://github.com/olszarai/labelapp_backend/blob/main/src/controllers/labelController.ts"
    click prismaClient "https://github.com/olszarai/labelapp_backend/tree/main/src/generated/prisma/"
    click tsconfig "https://github.com/olszarai/labelapp_backend/blob/main/tsconfig.json"
    click package "https://github.com/olszarai/labelapp_backend/blob/main/package.json"
    click gitignore "https://github.com/olszarai/labelapp_backend/blob/main/.gitignore"

    %% Styles
    classDef compute fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef database fill:#90ee90,stroke:#333,stroke-width:1px
    classDef external fill:#DDA0DD,stroke:#333,stroke-width:1px
    classDef artifact fill:#FFA500,stroke:#333,stroke-width:1px
```
