# tunghoang/procon-team-manager architecture

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

- Interactive diagram: https://gitdiagram.com/tunghoang/procon-team-manager
- Repository: https://github.com/tunghoang/procon-team-manager

## Overview

##### Project type and purpose
- This is a full-stack web application (“Procon Manager”) that provides a static SPA frontend (in build/) and a Node.js/Express backend (in src/) exposing RESTful APIs, backed by a relational database and a background job queue.

##### File structure
- Top-level
- build/                   ← compiled frontend assets (HTML/CSS/JS/images)
- src/                     ← backend source code
- *.sql                    ← database schemas/data for contests
- package.json             ← Node.js dependencies & scripts
- src/
- routes/                  ← Express route definitions (REST endpoints)
- controllers/             ← business logic for each resource (tournament, round, match, question, answer, team)
- models/                  ← ORM models (dbInstance.js + table definitions)
- middleware/              ← authentication & other request filters
- lib/                     ← shared utilities (encryption, common helpers, dynamic controller loader)
- jobqueue.js             ← background‐job producer/consumer logic
- docs.js + swagger.json  ← API documentation setup

##### README
- “npm/yarn dev” spins up the dev server
- “/docs” serves API documentation (Swagger UI)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Frontend Layer
    subgraph "Frontend Layer"
        Browser["Browser (SPA)"]:::frontend
        StaticAssets["Static Asset Server"]:::frontend
    end

    %% Backend Layer
    subgraph "Backend Layer"
        WebServer["Express API Server"]:::backend
        Auth["Auth Middleware"]:::backend
        subgraph "API Layer"
            Routes["RESTful API Routes"]:::backend
            Controllers["Controllers & Business Logic"]:::backend
        end
        subgraph "Data Layer"
            Models["ORM Models & Database Instance"]:::backend
            Database["Relational Database"]:::datastore
            DBScripts["Database Schema & Seed Scripts"]:::datastore
        end
        JobQueue["Background Job Queue Subsystem"]:::backend
        DocsUI["API Documentation (Swagger UI)"]:::doc
    end

    %% Connections
    Browser -->|"HTTP/HTTPS"| StaticAssets
    Browser -->|"HTTP/HTTPS"| WebServer
    WebServer --> Auth
    Auth --> Routes
    Routes --> Controllers
    Controllers --> Models
    Models -->|"SQL Queries"| Database
    Controllers -->|"Enqueue Task"| JobQueue
    JobQueue -->|"Process & SQL"| Database
    WebServer -->|"Serve Docs"| DocsUI

    %% Click Events
    click StaticAssets "https://github.com/tunghoang/procon-team-manager/tree/main/build/"
    click WebServer "https://github.com/tunghoang/procon-team-manager/blob/main/src/index.js"
    click Routes "https://github.com/tunghoang/procon-team-manager/tree/main/src/routes/"
    click Controllers "https://github.com/tunghoang/procon-team-manager/tree/main/src/controllers/"
    click Models "https://github.com/tunghoang/procon-team-manager/tree/main/src/models/"
    click Auth "https://github.com/tunghoang/procon-team-manager/blob/main/src/middleware/authenticate.js"
    click Common "https://github.com/tunghoang/procon-team-manager/blob/main/src/lib/common.js"
    click Encrypt "https://github.com/tunghoang/procon-team-manager/blob/main/src/lib/encrypt.js"
    click UseController "https://github.com/tunghoang/procon-team-manager/blob/main/src/lib/useController.js"
    click JobQueue "https://github.com/tunghoang/procon-team-manager/blob/main/src/jobqueue.js"
    click DocsUI "https://github.com/tunghoang/procon-team-manager/blob/main/src/docs.js"
    click SwaggerJSON "https://github.com/tunghoang/procon-team-manager/blob/main/src/swagger.json"
    click DBScripts "https://github.com/tunghoang/procon-team-manager/blob/main/procon_2024.sql"

    %% Styles
    classDef frontend fill:#CCE5FF,stroke:#0000FF,color:#000000
    classDef backend fill:#CCFFCC,stroke:#008000,color:#000000
    classDef datastore fill:#FFE5CC,stroke:#FF6600,color:#000000
    classDef doc fill:#E5CCFF,stroke:#800080,color:#000000
```
