# dammanhdungvn/teenup architecture

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

- Interactive diagram: https://gitdiagram.com/dammanhdungvn/teenup
- Repository: https://github.com/dammanhdungvn/teenup

## Overview

##### Project Type and Purpose
- This is a full-stack web application (“TeenUp Contest Management System”) that provides a UI for parents, students, classes and subscriptions management, backed by REST APIs in Spring Boot and a MySQL database. It is fully containerized via Docker Compose and includes cross-platform start/stop/health scripts.

##### File Structure Analysis
- Top-level service separation:
- frontend/ – React (Vite) code, Ant Design, Axios API clients, Dockerfile + Nginx config.
- backend/contest/ – Spring Boot project with controllers, services, repositories, entities, mappers, exception handlers, Dockerfile + Maven wrapper.
- docker-compose.yml – orchestrates frontend, backend, db.
- scripts/ & teenup.sh/.bat – helper scripts for developer workflows (start, stop, health).
- database_export/ – SQL dumps of tables.
- docs/ – API documentation.
- Patterns/Modules:
- Backend follows layered architecture (Controller → Service → Repository) with DTOs, mappers, exception handling.
- Frontend is an SPA with pages/components/services (API wrappers) → React Router.
- Data persistence: JPA to MySQL.
- Deployment via Docker Compose, health checks, volumes for persistence.

##### README Insights
- Tech stack summary: React + Vite + Ant Design + Axios; Spring Boot + Java 21 + MySQL 8 + JPA; Docker Compose; cross-platform scripts.
- Business rules and sample data seeding in DevDataSeeder.

a. Main Components
- Client/UI – React SPA (Browser).
- API Gateway/Reverse Proxy – Nginx in frontend container.
- Frontend Service – Node server or static files served.
- Backend Service – Spring Boot application exposing /api endpoints.
- Database – MySQL container.
- Auxiliary – Docker Compose orchestrator, cross-platform scripts.
b. Relationships & Data Flows
1. Browser → HTTP(S) → Nginx → React app.
2. React app (Axios) → HTTP → Spring Boot REST Controllers.
3. Controllers → call Service layer → Repository layer → MySQL.
4. DevDataSeeder → initial data load at startup.
5. Docker Compose → networks connecting frontend, backend, db.
c. Architectural Patterns
- Frontend: Component-based UI, service layer for API, client-side routing.
- Backend: Layered (Controller, Service, Repository), exception handling via ApiExceptionHandler, DTO mapping.
- Database: Relational with JPA entities.
- Deployment: Containerized micro-services style (though all in one compose).
d. Key Technologies
- React + Vite + Ant Design + Axios.
- Spring Boot 3 + Java 21 + Spring Data JPA.
- MySQL 8.
- Docker, Docker Compose, Nginx.
- Maven build, cross-platform shell/batch scripts.

##### Capturing Essential Elements
- Layering and separation of concerns: UI / API / Data.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Client Layer
    Browser["Browser (React SPA)"]:::client

    %% Edge Layer
    Nginx["Nginx Reverse Proxy"]:::infra

    %% Frontend Container
    subgraph "Frontend Container"
        FE_SRC["frontend/src"]:::frontend
        FE_HTML["frontend/index.html"]:::frontend
        FE_DOCKER["frontend/Dockerfile"]:::frontend
        FE_VITE["frontend/vite.config.js"]:::frontend
        FE_DCFE["docker-compose.yml (frontend svc)"]:::infra
    end

    %% Backend Container
    subgraph "Backend Container"
        BE_APP["ContestApplication.java"]:::backend
        BE_CTRL["controller/"]:::backend
        BE_SVC["service/"]:::backend
        BE_REPO["repository/"]:::backend
        BE_ENTITY["entity/"]:::backend
        BE_DTO["dto/"]:::backend
        BE_MAP["mapper/"]:::backend
        BE_EXC["exception/"]:::backend
        BE_PROP["application*.properties"]:::backend
        BE_DOCKER["Dockerfile"]:::backend
        BE_POM["pom.xml"]:::backend
        DevSeeder["DevDataSeeder.java"]:::backend
        BE_DCBE["docker-compose.yml (backend svc)"]:::infra
    end

    %% Database Container
    subgraph "Database Container"
        DB_DC["docker-compose.yml (db svc)"]:::infra
        DB_EXPORT["database_export/"]:::database
    end

    %% Developer Workflow Scripts
    subgraph "Developer Workflow Scripts"
        SCRIPTS_DIR["scripts/"]:::infra
        SCRIPT_SH["teenup.sh / teenup.bat"]:::infra
    end

    %% API Documentation
    subgraph "API Documentation"
        DOC_MD["docs/API.md"]:::infra
        DOC_DOC["docs/TeenUp_Bài test Fullstack Developer.docx"]:::infra
    end

    %% Connections
    Browser -->|"HTTP(S)"| Nginx
    Nginx -->|"serves static"| FE_SRC
    FE_SRC -->|"Axios HTTP /api"| BE_APP
    BE_APP -->|"JDBC (JPA)"| DB_DC

    SCRIPTS_DIR -->|"orchestrates"| FE_DCFE
    SCRIPTS_DIR -->|"orchestrates"| BE_DCBE
    SCRIPTS_DIR -->|"orchestrates"| DB_DC

    %% Click Events
    click FE_SRC "https://github.com/dammanhdungvn/teenup/tree/main/frontend/src"
    click FE_HTML "https://github.com/dammanhdungvn/teenup/blob/main/frontend/index.html"
    click FE_DOCKER "https://github.com/dammanhdungvn/teenup/tree/main/frontend/Dockerfile"
    click FE_VITE "https://github.com/dammanhdungvn/teenup/blob/main/frontend/vite.config.js"
    click FE_DCFE "https://github.com/dammanhdungvn/teenup/blob/main/docker-compose.yml"

    click BE_APP "https://github.com/dammanhdungvn/teenup/blob/main/backend/contest/src/main/java/com/teenup/contest/ContestApplication.java"
    click BE_CTRL "https://github.com/dammanhdungvn/teenup/tree/main/backend/contest/src/main/java/com/teenup/contest/controller"
    click BE_SVC "https://github.com/dammanhdungvn/teenup/tree/main/backend/contest/src/main/java/com/teenup/contest/service"
    click BE_REPO "https://github.com/dammanhdungvn/teenup/tree/main/backend/contest/src/main/java/com/teenup/contest/repository"
    click BE_ENTITY "https://github.com/dammanhdungvn/teenup/tree/main/backend/contest/src/main/java/com/teenup/contest/entity"
    click BE_DTO "https://github.com/dammanhdungvn/teenup/tree/main/backend/contest/src/main/java/com/teenup/contest/dto"
    click BE_MAP "https://github.com/dammanhdungvn/teenup/tree/main/backend/contest/src/main/java/com/teenup/contest/mapper"
    click BE_EXC "https://github.com/dammanhdungvn/teenup/tree/main/backend/contest/src/main/java/com/teenup/contest/exception"
    click BE_PROP "https://github.com/dammanhdungvn/teenup/blob/main/backend/contest/src/main/resources/application*.properties"
    click BE_DOCKER "https://github.com/dammanhdungvn/teenup/tree/main/backend/contest/Dockerfile"
    click BE_POM "https://github.com/dammanhdungvn/teenup/blob/main/backend/contest/pom.xml"
    click DevSeeder "https://github.com/dammanhdungvn/teenup/blob/main/backend/contest/src/main/java/com/teenup/contest/config/DevDataSeeder.java"
    click BE_DCBE "https://github.com/dammanhdungvn/teenup/blob/main/docker-compose.yml"

    click DB_DC "https://github.com/dammanhdungvn/teenup/blob/main/docker-compose.yml"
    click DB_EXPORT "https://github.com/dammanhdungvn/teenup/tree/main/database_export/"

    click SCRIPTS_DIR "https://github.com/dammanhdungvn/teenup/tree/main/scripts/"
    click SCRIPT_SH "https://github.com/dammanhdungvn/teenup/blob/main/teenup.sh"
    
    click DOC_MD "https://github.com/dammanhdungvn/teenup/blob/main/docs/API.md"
    click DOC_DOC "https://github.com/dammanhdungvn/teenup/blob/main/docs/TeenUp_Bài test Fullstack Developer.docx"

    %% Styles
    classDef client fill:#ADD8E6,stroke:#333,stroke-width:1px;
    classDef frontend fill:#90EE90,stroke:#333,stroke-width:1px;
    classDef backend fill:#90EE90,stroke:#333,stroke-width:1px;
    classDef database fill:#FFA500,stroke:#333,stroke-width:1px;
    classDef infra fill:#D3D3D3,stroke:#333,stroke-width:1px;
```
