# boanlai/todo-list architecture

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

- Interactive diagram: https://gitdiagram.com/boanlai/todo-list
- Repository: https://github.com/boanlai/todo-list

## Overview

##### Project Type and Purpose
- This is a classic full-stack CRUD application.
- Purpose: allow users to view/add/update “missions” (todo items), persisted in MySQL, with a Vue.js single-page frontend served by Spring Boot.

##### Main Architectural Components
a. Frontend (Vue.js SPA)
– Located under src/main/resources/static (index.html + JS/CSS bundles).
– Runs in the user’s browser, calls REST APIs.
b. Backend (Spring Boot Application)
– Entry point: TodoListApplication (src/main/java/com/boan/todo_list).
– Web layer:
- ViewController – serves homepage (index.html).
- ApiController – exposes REST endpoints (/api/… for CRUD).
- IpCaptureFilter – servlet filter capturing request IPs.
– Business layer:
- MissionService – business logic for missions.
- MissionAuditorAware – supplies auditing metadata.
- MyCommandLineRunner – initial data loader on startup.
– Data layer:
- MissionRepo – Spring Data JPA repository.
- Mission – @Entity mapping to MySQL table.
c. Database (MySQL)
– Schema defined by src/main/db/ddl.sql.
– Configured via application.properties and JpaConfig.
d. Config & Bootstrapping
– pom.xml / mvnw – Maven build & dependency management.
– application.properties – datasource, JPA settings.
– WebConfig – CORS, resource handlers.

##### Relationships & Data Flows
1. Browser → (HTTP) → Spring Boot Web Server
– ViewController returns index.html.
– Vue router loads the SPA.
2. SPA → (XHR/Fetch) → ApiController
– GET/POST/PUT/DELETE on /api/missions.
3. ApiController → MissionService → MissionRepo → MySQL
– JPA abstracts SQL operations.
4. MyCommandLineRunner → runs at startup → preload DB via MissionService.
5. IpCaptureFilter → intercepts all incoming requests → logs/stores IP (cross-cutting).

##### Architectural Patterns & Principles
- Layered (Controller → Service → Repository)
- MVC for view vs. REST API separation
- Single-page app served as static content
- Dependency Injection & Inversion of Control (Spring)
- Convention-over-Configuration (Spring Boot auto-config)
- Build Automation (Maven)

##### Detailed Steps to Sketch
a. Web Layer: IpCaptureFilter → ViewController, ApiController
b. Service Layer: MissionService, MissionAuditorAware, MyCommandLineRunner
c. Data Layer: MissionRepo → Mission (Entity)
4. Connect:
– Browser → ViewController (HTTP GET /)
– Browser → ApiController (XHR JSON API)
– ApiController → MissionService (method calls)
– MissionService → MissionRepo (JPA)
– MissionRepo → MySQL (JDBC)
5. Configuration files (application.properties, pom.xml) at the bottom or side.
6. Use arrowheads to indicate direction of data flow.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Client
    Browser["Browser (Vue.js SPA)"]:::frontend
    click Browser "https://github.com/boanlai/todo-list/tree/main/src/main/resources/static"

    %% Spring Boot Application
    subgraph "Spring Boot Application"
        TodoListApplication["TodoListApplication"]:::backend
        click TodoListApplication "https://github.com/boanlai/todo-list/blob/main/src/main/java/com/boan/todo_list/TodoListApplication.java"

        subgraph "Web Layer"
            Filter["IpCaptureFilter"]:::web
            click Filter "https://github.com/boanlai/todo-list/blob/main/src/main/java/com/boan/todo_list/IpCaptureFilter.java"
            ViewController["ViewController"]:::web
            click ViewController "https://github.com/boanlai/todo-list/blob/main/src/main/java/com/boan/todo_list/ViewController.java"
            ApiController["ApiController"]:::web
            click ApiController "https://github.com/boanlai/todo-list/blob/main/src/main/java/com/boan/todo_list/ApiController.java"
        end

        subgraph "Service Layer"
            MissionService["MissionService"]:::service
            click MissionService "https://github.com/boanlai/todo-list/blob/main/src/main/java/com/boan/todo_list/MissionService.java"
            MissionAuditorAware["MissionAuditorAware"]:::service
            click MissionAuditorAware "https://github.com/boanlai/todo-list/blob/main/src/main/java/com/boan/todo_list/MissionAuditorAware.java"
            MyCommandLineRunner["MyCommandLineRunner"]:::service
            click MyCommandLineRunner "https://github.com/boanlai/todo-list/blob/main/src/main/java/com/boan/todo_list/MyCommandLineRunner.java"
        end

        subgraph "Data Layer"
            MissionRepo["MissionRepo"]:::data
            click MissionRepo "https://github.com/boanlai/todo-list/blob/main/src/main/java/com/boan/todo_list/MissionRepo.java"
            Mission["Mission (Entity)"]:::data
            click Mission "https://github.com/boanlai/todo-list/blob/main/src/main/java/com/boan/todo_list/Mission.java"
        end

        subgraph "Config"
            JpaConfig["JpaConfig"]:::config
            click JpaConfig "https://github.com/boanlai/todo-list/blob/main/src/main/java/com/boan/todo_list/config/JpaConfig.java"
            WebConfig["WebConfig"]:::config
            click WebConfig "https://github.com/boanlai/todo-list/blob/main/src/main/java/com/boan/todo_list/config/WebConfig.java"
        end
    end

    %% Database
    MySQL["MySQL Database (ddl.sql)"]:::database
    click MySQL "https://github.com/boanlai/todo-list/blob/main/src/main/db/ddl.sql"

    %% External Config & Build
    applicationProperties["application.properties"]:::config
    click applicationProperties "https://github.com/boanlai/todo-list/blob/main/src/main/resources/application.properties"
    pom["pom.xml & mvnw"]:::build
    click pom "https://github.com/boanlai/todo-list/blob/main/pom.xml"

    %% Connections
    Browser -->|"HTTP GET /"| ViewController
    Browser -->|"XHR/Fetch JSON"| ApiController

    Filter -->|"intercepts"| ViewController
    Filter -->|"intercepts"| ApiController

    ApiController -->|"calls"| MissionService
    MissionService -->|"uses JPA"| MissionRepo
    MissionRepo -->|"JDBC"| MySQL

    MyCommandLineRunner -->|"startup preload"| MissionService

    pom -->|"build/package"| TodoListApplication

    %% Styles
    classDef frontend fill:#BBDEFB,stroke:#2196F3,color:#0D47A1;
    classDef backend fill:#C8E6C9,stroke:#388E3C,color:#1B5E20;
    classDef web fill:#A5D6A7,stroke:#2E7D32,color:#1B5E20;
    classDef service fill:#C5E1A5,stroke:#558B2F,color:#33691E;
    classDef data fill:#DCEDC8,stroke:#7CB342,color:#33691E;
    classDef database fill:#FFE0B2,stroke:#FB8C00,color:#E65100;
    classDef config fill:#E0E0E0,stroke:#9E9E9E,color:#424242;
    classDef build fill:#E1BEE7,stroke:#8E24AA,color:#4A148C;
```
