# webby813/todoit-backend architecture

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

- Interactive diagram: https://gitdiagram.com/webby813/todoit-backend
- Repository: https://github.com/webby813/todoit-backend

## Overview

##### Main System Components
a. Clients
- Web browsers (Blade views served via `public/index.php`)
- Third-party API consumers (mobile apps, Postman, etc.)
b. Ingress Layer
- Web server (Nginx or Apache)
- SSL/TLS termination (if present)
c. Application Layer
- PHP runtime (PHP-FPM)
- Laravel framework
d. API Layer
- API routing (`routes/api.php`)
- Controllers (`app/Http/Controllers/Api/V1/*`)
- Form Requests (`app/Http/Requests/V1`) for validation
- API Resources (`app/Http/Resources/V1`) for output formatting
- Authentication via Sanctum (`config/sanctum.php`)
e. Web (Blade) Layer
- Web routing (`routes/web.php`)
- Blade views (`resources/views/*.blade.php`)
- Asset pipeline (Vite, JS/CSS under `resources/js`, `resources/css`)
f. Domain & Persistence
- Eloquent Models (`app/Models/*`) – User, TodoTask, pivot table
- Database (MySQL, PostgreSQL) with Migrations (`database/migrations`)
- Factories & Seeders (`database/factories`, `database/seeders`)
g. Infrastructure Services
- Cache (Redis, file)
- Queue (jobs table, workers)
- Storage (local/public under `storage/app`)
- Logging (`storage/logs`)
- Session management
- Configuration (`config/*.php`)

##### Relationships & Data Flow
- Browser → Nginx/Apache → `public/index.php` → Laravel bootstraps →
- If route is under `/api/v1/*`: pass through API middleware → Controller →
Request validation → Business logic → Eloquent → Database →
Resource transformation → JSON response → Browser or client.
- If route is a web route: Controller → Blade view rendering → HTML/CSS/JS → Browser.
- Asset requests (JS, CSS) → Vite dev server or compiled assets in `public` → Browser.
- Background jobs: dispatched from Controllers or Events → queued (DB/Redis) → Worker consumes → updates Database / sends notifications.

##### Architectural Patterns & Principles
- MVC pattern: Controllers, Models, Views.
- Layered architecture: Routing → Controllers → Requests → Domain → Persistence → Resources.
- Separation of concerns: Validation in Form Requests, presentation in Resources/Views.
- RESTful API design under versioned namespace (`Api\V1`).
- Dependency injection container (`Providers/*.php`) for service bindings.
- Environment configuration (`.env.example`) for 12-factor compliance.

##### Technologies, Frameworks & Libraries
- PHP + Laravel 10.x
- Sanctum for API authentication
- Eloquent ORM for database abstractions
- Vite (via `vite.config.js`) for asset bundling
- PHPUnit for testing (`tests/`)
- Composer & NPM for dependency management
- Blade templating engine
- Redis (optional) for cache/queues

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Clients Layer
    subgraph "Clients" 
        direction TB
        Browser["Web Browser"]:::client
        APIClient["API Consumers"]:::client
    end

    %% Ingress Layer
    subgraph "Ingress Layer"
        direction TB
        WebServer["Nginx/Apache"]:::infra
        SSL["SSL/TLS Termination"]:::infra
    end

    %% Application Layer
    subgraph "Laravel Application" 
        direction TB
        PHPFPM["PHP-FPM"]:::infra
        Laravel["Laravel Framework"]:::app

        subgraph "Web (Blade) Layer"
            direction TB
            WebRoutes["Web Routing\n(routes/web.php)"]:::app
            BladeViews["Blade Views\n(resources/views/*.blade.php)"]:::app
        end

        subgraph "API v1 Layer"
            direction TB
            APIRoutes["API Routing\n(routes/api.php)"]:::app
            AuthController["API Controller:\nAuthController"]:::app
            UserController["API Controller:\nUserController"]:::app
            TodoController["API Controller:\nTodoTaskController"]:::app
            FormRequests["Form Requests\n(app/Http/Requests/V1)"]:::app
            APIResources["API Resources\n(app/Http/Resources/V1)"]:::app
            Sanctum["Sanctum Middleware\n(config/sanctum.php)"]:::app
        end

        subgraph "Domain & Persistence"
            direction TB
            Models["Eloquent Models\n(app/Models)"]:::app
            Migrations["Migrations\n(database/migrations)"]:::infra
            Factories["Factories & Seeders\n(database/factories, seeders)"]:::infra
            DB["Database\n(MySQL/PostgreSQL)"]:::infra
        end

        subgraph "Infrastructure Services"
            direction TB
            Cache["Cache\n(Redis/File)"]:::infra
            Queue["Queue\n(DB/Redis)"]:::infra
            Storage["Storage\n(storage/app)"]:::infra
            Logs["Logging\n(storage/logs)"]:::infra
            Session["Session Management"]:::infra
            ConfigFiles["Configuration\n(config/*.php, .env.example)"]:::config
        end
    end

    %% Asset Pipeline
    subgraph "Asset Pipeline"
        direction TB
        JS["JS/CSS Source\n(resources/js, resources/css)"]:::app
        Vite["Vite Bundler\n(vite.config.js)"]:::app
        PublicAssets["Compiled Assets\n(public)"]:::infra
    end

    %% Testing & CI
    subgraph "Testing"
        direction TB
        FeatureTests["Feature Tests\n(tests/Feature)"]:::app
        UnitTests["Unit Tests\n(tests/Unit)"]:::app
    end

    %% Relationships
    Browser -->|requests| WebServer
    APIClient -->|requests| WebServer
    WebServer --> SSL
    SSL --> PHPFPM
    PHPFPM --> Laravel

    %% Web flow
    Laravel --> WebRoutes
    WebRoutes --> BladeViews
    BladeViews -->|render HTML| Browser

    %% API flow
    Laravel --> APIRoutes
    APIRoutes --> Sanctum
    Sanctum --> AuthController
    AuthController --> FormRequests
    AuthController --> Models
    AuthController --> APIResources
    AuthController --> DB
    APIRoutes --> UserController
    UserController --> FormRequests
    UserController --> Models
    UserController --> APIResources
    UserController --> DB
    APIRoutes --> TodoController
    TodoController --> FormRequests
    TodoController --> Models
    TodoController --> APIResources
    TodoController --> DB

    %% Asset flow
    Browser --> PublicAssets
    PublicAssets -->|served| Browser
    JS --> Vite
    Vite --> PublicAssets

    %% Domain & Persistence
    Laravel --> Models
    Models --> DB
    Migrations --> DB
    Factories --> DB

    %% Infra services usage
    Laravel --> Cache
    Laravel --> Queue
    Queue --> DB
    Laravel --> Storage
    Laravel --> Logs
    Laravel --> Session
    Laravel --> ConfigFiles

    %% Testing
    Laravel --> FeatureTests
    Laravel --> UnitTests

    %% Click events
    click Browser "https://github.com/webby813/todoit-backend/blob/main/public/index.php"
    click WebRoutes "https://github.com/webby813/todoit-backend/blob/main/routes/web.php"
    click BladeViews "https://github.com/webby813/todoit-backend/blob/main/resources/views/welcome.blade.php"
    click APIRoutes "https://github.com/webby813/todoit-backend/blob/main/routes/api.php"
    click AuthController "https://github.com/webby813/todoit-backend/blob/main/app/Http/Controllers/Api/V1/AuthController.php"
    click UserController "https://github.com/webby813/todoit-backend/blob/main/app/Http/Controllers/Api/V1/UserController.php"
    click TodoController "https://github.com/webby813/todoit-backend/blob/main/app/Http/Controllers/Api/V1/TodoTaskController.php"
    click FormRequests "https://github.com/webby813/todoit-backend/blob/main/app/Http/Requests/V1/StoreUserRequest.php"
    click FormRequests "https://github.com/webby813/todoit-backend/blob/main/app/Http/Requests/V1/TodoTaskRequest.php"
    click APIResources "https://github.com/webby813/todoit-backend/blob/main/app/Http/Resources/V1/UserResource.php"
    click APIResources "https://github.com/webby813/todoit-backend/blob/main/app/Http/Resources/V1/TodoTaskResource.php"
    click Models "https://github.com/webby813/todoit-backend/blob/main/app/Models/User.php"
    click Models "https://github.com/webby813/todoit-backend/blob/main/app/Models/TodoTask.php"
    click Models "https://github.com/webby813/todoit-backend/blob/main/app/Models/Todo_user.php"
    click Migrations "https://github.com/webby813/todoit-backend/blob/main/database/migrations/0001_01_01_000000_create_users_table.php"
    click Migrations "https://github.com/webby813/todoit-backend/blob/main/database/migrations/0001_01_01_000001_create_cache_table.php"
    click Migrations "https://github.com/webby813/todoit-backend/blob/main/database/migrations/0001_01_01_000002_create_jobs_table.php"
    click Migrations "https://github.com/webby813/todoit-backend/blob/main/database/migrations/2025_04_11_132304_create_personal_access_tokens_table.php"
    click Migrations "https://github.com/webby813/todoit-backend/blob/main/database/migrations/2025_04_11_133044_create_users_table.php"
    click Migrations "https://github.com/webby813/todoit-backend/blob/main/database/migrations/2025_04_16_154337_todo_task_table.php"
    click Factories "https://github.com/webby813/todoit-backend/blob/main/database/factories/UserFactory.php"
    click Factories "https://github.com/webby813/todoit-backend/blob/main/database/seeders/DatabaseSeeder.php"
    click ConfigFiles "https://github.com/webby813/todoit-backend/blob/main/config/app.php"
    click ConfigFiles "https://github.com/webby813/todoit-backend/blob/main/config/auth.php"
    click ConfigFiles "https://github.com/webby813/todoit-backend/blob/main/config/cache.php"
    click ConfigFiles "https://github.com/webby813/todoit-backend/blob/main/config/queue.php"
    click ConfigFiles "https://github.com/webby813/todoit-backend/blob/main/config/session.php"
    click ConfigFiles "https://github.com/webby813/todoit-backend/blob/main/config/sanctum.php"
    click Vite "https://github.com/webby813/todoit-backend/blob/main/vite.config.js"
    click JS "https://github.com/webby813/todoit-backend/blob/main/resources/js/app.js"
    click JS "https://github.com/webby813/todoit-backend/blob/main/resources/js/bootstrap.js"
    click JS "https://github.com/webby813/todoit-backend/blob/main/resources/css/app.css"
    click Storage "https://github.com/webby813/todoit-backend/tree/main/storage/app"
    click Storage "https://github.com/webby813/todoit-backend/tree/main/storage/app/public"
    click Storage "https://github.com/webby813/todoit-backend/tree/main/storage/app/private"
    click Storage "https://github.com/webby813/todoit-backend/tree/main/storage/framework/cache"
    click Storage "https://github.com/webby813/todoit-backend/tree/main/storage/framework/sessions"
    click Logs "https://github.com/webby813/todoit-backend/tree/main/storage/logs"
    click ConfigFiles "https://github.com/webby813/todoit-backend/blob/main/.env.example"
    click ConfigFiles "https://github.com/webby813/todoit-backend/blob/main/composer.json"
    click ConfigFiles "https://github.com/webby813/todoit-backend/blob/main/package.json"
    click FeatureTests "https://github.com/webby813/todoit-backend/blob/main/tests/Feature/ExampleTest.php"
    click UnitTests "https://github.com/webby813/todoit-backend/blob/main/tests/Unit/ExampleTest.php"
    click UnitTests "https://github.com/webby813/todoit-backend/blob/main/tests/TestCase.php"

    %% Styles
    classDef client fill:#FFA500,stroke:#333,stroke-width:1px
    classDef infra fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef app fill:#90EE90,stroke:#333,stroke-width:1px
    classDef config fill:#FFE4B5,stroke:#333,stroke-width:1px
```
