# pedrolgr/task-list architecture

> Architecture diagram of the GitHub repository pedrolgr/task-list, 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/pedrolgr/task-list
- Repository: https://github.com/pedrolgr/task-list

## Overview

##### Project Type and Purpose
- This is a full-stack task-management web application.
- Frontend: React single-page application (SPA) created with Create React App.
- Backend: Node.js/Express API written in TypeScript that handles authentication using TypeORM and a relational database (configured via ormconfig.json).

##### File Structure Analysis
- client/ – React application
– public/ – static HTML and assets
– src/ – React source code
· components/ – reusable UI components (AddTask, TaskList, etc.)
· pages/ – top-level screens (Login, Signup, TaskApp)
· context/ – state management via React Context (TasksContext)
- server/ – Express API
– src/
· app.ts – Express app setup, middleware, body parsing
· routes/authRoutes.ts – defines POST /login and POST /register
· controllers/AuthController*.ts – controller logic for login & registration
· data-source.ts – TypeORM DataSource initialization
· models/User.ts – user entity definition
– ormconfig.json – DB connection details
- tsconfig.json – shared TypeScript settings

##### Key Architectural Patterns
- Frontend uses Component-Based and Context-Based state management.
- Backend follows a thin-controller pattern layered over TypeORM (MVC-lite).
- Data flow is request/response over HTTP between the SPA and the Express API.

##### Main Components
A. User’s Browser/UI Layer
– Pages: Login, Signup, TaskApp
– Components: TaskList, Task, AddTask, TaskForm, etc.
– Context Provider: TasksContext (manages in-memory task list)
B. API Layer – Express Server
– Entry point: server/dist/server.js (or src/app.ts)
– Routing: authRoutes → Controllers
– Controllers: AuthControllerLogin & AuthControllerRegister
– ORM/Data Access: TypeORM DataSource & User model
C. Persistence Layer
– Relational Database (PostgreSQL/MySQL/SQLite per ormconfig.json)
D. (Optional Extensions)
– Token Store (if JWT is used)
– Static File Hosting/CDN for production React build

##### Relationships and Data Flows
1. User interacts with React UI → triggers login/signup forms
2. SPA issues HTTP POST to /api/auth/login or /api/auth/register
3. Express authRoutes receives request → delegates to AuthController
4. AuthController uses TypeORM DataSource to query/write User entity in DB
5. API responds with success/failure and possibly a JWT
6. React stores token in localStorage (or context) and transitions to TaskApp page
7. (Future) TaskApp page would fetch/save tasks via additional API endpoints

– Login & Signup pages
– TaskApp page + TaskContext
– Routes Layer (authRoutes.ts)
– Controllers (AuthControllerLogin, AuthControllerRegister)
– Data-Source/ORM Layer (data-source.ts + User model)
– Browser → Frontend pages (UI events)
– Frontend → API Server (HTTP requests)
– API Server → Database (ORM queries)
– Database → API Server (query results)
– API Server → Frontend (HTTP responses)

## Diagram (Mermaid)

```mermaid
flowchart TD
    User["User Browser"]:::user

    subgraph "Frontend"
        direction TB
        Index["React Entry Point\n(index.js)"]:::frontend
        AppComp["App Component\n(App.js)"]:::frontend
        LoginPage["Login Page"]:::frontend
        SignupPage["Signup Page"]:::frontend
        TaskAppPage["TaskApp Page"]:::frontend
        TasksContext["TasksContext Provider"]:::frontend
        TaskList["TaskList Component"]:::frontend
        TaskComp["Task Component"]:::frontend
        AddTask["AddTask Component"]:::frontend
        TaskForm["TaskForm Component"]:::frontend
        NewTaskBtn["NewTaskButton Component"]:::frontend
    end

    subgraph "API Server"
        direction TB
        ExpressApp["Express App Setup\n(app.ts)"]:::backend
        AuthRoutes["authRoutes"]:::backend
        AuthLogin["AuthControllerLogin"]:::backend
        AuthRegister["AuthControllerRegister"]:::backend
        DataSource["TypeORM DataSource Init"]:::backend
        UserEntity["User Entity\n(models/User.ts)"]:::backend
    end

    DB["Relational Database"]:::db

    %% Frontend Flow
    User -->|"loads SPA"| Index
    Index --> AppComp
    AppComp --> LoginPage
    AppComp --> SignupPage
    AppComp --> TaskAppPage
    TaskAppPage --> TasksContext
    TaskAppPage --> TaskList
    TaskAppPage --> AddTask
    AddTask --> TaskForm
    TaskList --> TaskComp
    TaskAppPage --> NewTaskBtn

    %% Frontend to Backend
    LoginPage -->|"POST /api/auth/login"| AuthRoutes
    SignupPage -->|"POST /api/auth/register"| AuthRoutes
    TaskAppPage -->|"(future) /api/tasks"| AuthRoutes

    %% Backend Flow
    AuthRoutes --> AuthLogin
    AuthRoutes --> AuthRegister
    AuthLogin --> DataSource
    AuthRegister --> DataSource
    DataSource --> UserEntity
    UserEntity --> DB
    DB --> UserEntity
    UserEntity --> DataSource
    DataSource --> AuthLogin
    DataSource --> AuthRegister
    AuthLogin --> AuthRoutes
    AuthRegister --> AuthRoutes
    AuthLogin -->|"response JWT"| LoginPage
    AuthRegister -->|"response JWT"| SignupPage

    %% Click Events
    click LoginPage "https://github.com/pedrolgr/task-list/blob/main/client/src/pages/Login.js"
    click SignupPage "https://github.com/pedrolgr/task-list/blob/main/client/src/pages/Signup.js"
    click TaskAppPage "https://github.com/pedrolgr/task-list/blob/main/client/src/pages/TaskApp.js"
    click TaskList "https://github.com/pedrolgr/task-list/blob/main/client/src/components/TaskList.js"
    click TaskComp "https://github.com/pedrolgr/task-list/blob/main/client/src/components/Task.js"
    click AddTask "https://github.com/pedrolgr/task-list/blob/main/client/src/components/AddTask.js"
    click TaskForm "https://github.com/pedrolgr/task-list/blob/main/client/src/components/TaskForm.js"
    click NewTaskBtn "https://github.com/pedrolgr/task-list/blob/main/client/src/components/NewTaskButton.js"
    click TasksContext "https://github.com/pedrolgr/task-list/blob/main/client/src/context/TasksContext.js"
    click Index "https://github.com/pedrolgr/task-list/blob/main/client/src/index.js"
    click AppComp "https://github.com/pedrolgr/task-list/blob/main/client/src/App.js"
    click ExpressApp "https://github.com/pedrolgr/task-list/blob/main/server/src/app.ts"
    click AuthRoutes "https://github.com/pedrolgr/task-list/blob/main/server/src/routes/authRoutes.ts"
    click AuthLogin "https://github.com/pedrolgr/task-list/blob/main/server/src/controllers/AuthControllerLogin.ts"
    click AuthRegister "https://github.com/pedrolgr/task-list/blob/main/server/src/controllers/AuthControllerRegister.ts"
    click DataSource "https://github.com/pedrolgr/task-list/blob/main/server/src/data-source.ts"
    click UserEntity "https://github.com/pedrolgr/task-list/blob/main/server/src/models/User.ts"
    click DB "https://github.com/pedrolgr/task-list/blob/main/server/ormconfig.json"

    %% Styles
    classDef frontend fill:#D0E8FF,stroke:#0366d6,color:#0366d6
    classDef backend fill:#DFFFE0,stroke:#28A745,color:#22863A
    classDef db fill:#FFE8B5,stroke:#D29922,color:#B08800
    classDef user fill:#F0F0F0,stroke:#6A737D,color:#24292E,nodeShape:ellipse
```
