# enzob123/senff architecture

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

- Interactive diagram: https://gitdiagram.com/enzob123/senff
- Repository: https://github.com/enzob123/senff

## Overview

##### Project Type and Purpose
- This is a full-stack, containerized Laravel web application for task management.
- It uses MVC on the backend (Laravel 12.x, PHP 8.3) with Blade/Tailwind/Alpine.js on the frontend, plus asynchronous job processing (RabbitMQ) for e-mail notifications and report generation.

##### Main Architectural Components
A. Containers & Runtime
1. Nginx (reverse proxy / HTTP server)
2. PHP-FPM (Laravel application)
3. PostgreSQL (relational data store)
4. Redis (cache & session store)
5. RabbitMQ (message broker / queue)
6. Optional: Mailtrap (external SMTP service for dev)
B. Laravel Application Layers
1. HTTP Layer
- Routes (web.php, api.php) → Controllers (AuthController, TaskController, DashboardController)
- Request Validation (StoreTaskRequest, UpdateTaskRequest)
- Policies (TaskPolicy) for authorization
2. Domain Layer
- Models (User, Task)
- Observers (TaskObserver)
- Exports (TasksExport)
3. Job/Queue Layer
- Jobs enqueued on task creation/update or report request (GenerateTaskReportJob, SendTaskCreatedNotificationJob, etc.)
- Workers consume from RabbitMQ, execute jobs
4. Notification Layer
- Mailable classes (ReportReadyMail, TaskCreatedMail, TaskCompletedMail)
- Mail driver configured for Mailtrap
5. Persistence & Storage
- Database migrations & seeders (Postgres)
- File storage (CSV/XLSX reports in storage/app/reports)
- Cache/sessions (Redis)

##### Component Interactions & Data Flow
- User browser → Nginx → PHP-FPM → Laravel Controller
- Controller ↔ PostgreSQL for CRUD
- Controller dispatches Jobs → RabbitMQ
- Queue Worker (PHP-FPM) ← RabbitMQ → executes Job →
- writes report file to storage
- sends e-mail via Mailtrap SMTP
- Frontend assets served by Vite (dev) or built CSS/JS (prod)
- Redis handles session persistence & caching reads/writes

##### Architectural Patterns & Principles
- MVC for web requests
- Policy-based authorization for resource ownership
- Observer pattern on Task model for domain events
- Asynchronous, event-driven architecture for notifications and reports
- Containerization & 12-factor app principles (env config, logs, backing services)

##### Technologies & Frameworks to Annotate
- Backend: Laravel (Controllers, Requests, Jobs, Models, Policies, Observers)
- Frontend: Blade templates, Tailwind CSS, Alpine.js, Vite
- DB: PostgreSQL 15
- Cache/Session: Redis
- Queue: RabbitMQ (enqueue/laravel-queue)
- Export: maatwebsite/excel
- Containerization: Docker, Docker Compose
- Testing: PHPUnit (Feature & Unit tests)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% External Entities
    Browser["User Browser"]:::external
    Vite["Vite (Dev Asset Server)"]:::tool
    Browser -.->|Assets| Vite

    %% Containers Layer
    subgraph "Containers" 
        direction TB
        Nginx["Nginx (Reverse Proxy)"]:::container
        PHPFPM["PHP-FPM (App Container)"]:::container
        Postgres["PostgreSQL"]:::service
        Redis["Redis (Cache & Session)"]:::service
        RabbitMQ["RabbitMQ (Message Broker)"]:::service
        Mailtrap["Mailtrap (SMTP Service)"]:::service
    end

    Browser -->|HTTP Request| Nginx
    Nginx -->|Forward Request| PHPFPM
    PHPFPM -->|Read/Write| Postgres
    PHPFPM -->|Cache/Session| Redis
    PHPFPM -->|Enqueue Job| RabbitMQ
    RabbitMQ -.->|Dispatch to Worker| PHPFPM
    PHPFPM -->|Send Email| Mailtrap

    %% App Container Modules
    subgraph "App Container (PHP-FPM)" 
        direction TB
        %% HTTP Layer
        subgraph "HTTP Layer"
            direction TB
            WebRoutes["Routes:web.php"]:::module
            ApiRoutes["Routes:api.php"]:::module
            AuthController["AuthController"]:::module
            TaskController["TaskController"]:::module
            DashboardController["DashboardController"]:::module
            StoreRequest["StoreTaskRequest"]:::module
            UpdateRequest["UpdateTaskRequest"]:::module
            TaskPolicy["TaskPolicy"]:::module
        end

        %% Domain Layer
        subgraph "Domain Layer"
            direction TB
            UserModel["User Model"]:::module
            TaskModel["Task Model"]:::module
            TaskObserver["TaskObserver"]:::module
            TasksExport["TasksExport"]:::module
        end

        %% Job/Queue Layer
        subgraph "Job/Queue Layer"
            direction TB
            GenReportJob["GenerateTaskReportJob"]:::module
            CreatedNotifJob["SendTaskCreatedNotificationJob"]:::module
            CompletedNotifJob["SendTaskCompletedNotificationJob"]:::module
            ReportEmailJob["SendReportReadyEmailJob"]:::module
            GenericNotifJob["SendTaskNotification"]:::module
        end

        %% Notification Layer
        subgraph "Notification Layer"
            direction TB
            ReportReadyMail["ReportReadyMail"]:::module
            TaskCreatedMail["TaskCreatedMail"]:::module
            TaskCompletedMail["TaskCompletedMail"]:::module
        end

        %% Persistence & Storage
        subgraph "Persistence & Storage"
            direction TB
            Migrations["Migrations"]:::module
            Seeders["Seeders"]:::module
            FileStorage["Report Files (storage/app/reports)"]:::module
        end
    end

    %% HTTP Flow
    PHPFPM --> WebRoutes
    WebRoutes --> AuthController
    WebRoutes --> TaskController
    WebRoutes --> DashboardController
    ApiRoutes --> TaskController

    AuthController --> StoreRequest
    TaskController --> StoreRequest
    TaskController --> UpdateRequest
    AuthController --> TaskPolicy
    TaskController --> TaskPolicy

    %% Domain interactions
    TaskController --> UserModel
    TaskController --> TaskModel
    TaskModel --> TaskObserver
    TaskController --> TasksExport

    %% Job Flow
    TaskController --> GenReportJob
    TaskController --> CreatedNotifJob
    TaskController --> CompletedNotifJob

    GenReportJob --> FileStorage
    GenReportJob --> ReportEmailJob
    CreatedNotifJob --> TaskCreatedMail
    CompletedNotifJob --> TaskCompletedMail

    %% Queue interactions
    RabbitMQ --> GenReportJob
    RabbitMQ --> CreatedNotifJob
    RabbitMQ --> CompletedNotifJob
    RabbitMQ --> ReportEmailJob

    %% Styling
    classDef external fill:#f9f,stroke:#333,stroke-width:1px
    classDef container fill:#9cf,stroke:#333,stroke-width:1px
    classDef service fill:#ccc,stroke:#333,stroke-width:1px
    classDef module fill:#fff,stroke:#333,stroke-width:1px
    classDef tool fill:#cfc,stroke:#333,stroke-width:1px

    %% Click Events
    click Nginx "https://github.com/enzob123/senff/blob/main/nginx/default.conf"
    click WebRoutes "https://github.com/enzob123/senff/blob/main/routes/web.php"
    click ApiRoutes "https://github.com/enzob123/senff/blob/main/routes/api.php"
    click AuthController "https://github.com/enzob123/senff/blob/main/app/Http/Controllers/AuthController.php"
    click TaskController "https://github.com/enzob123/senff/blob/main/app/Http/Controllers/TaskController.php"
    click DashboardController "https://github.com/enzob123/senff/blob/main/app/Http/Controllers/DashboardController.php"
    click StoreRequest "https://github.com/enzob123/senff/blob/main/app/Http/Requests/StoreTaskRequest.php"
    click UpdateRequest "https://github.com/enzob123/senff/blob/main/app/Http/Requests/UpdateTaskRequest.php"
    click TaskPolicy "https://github.com/enzob123/senff/blob/main/app/Policies/TaskPolicy.php"
    click UserModel "https://github.com/enzob123/senff/blob/main/app/Models/User.php"
    click TaskModel "https://github.com/enzob123/senff/blob/main/app/Models/Task.php"
    click TaskObserver "https://github.com/enzob123/senff/blob/main/app/Observers/TaskObserver.php"
    click TasksExport "https://github.com/enzob123/senff/blob/main/app/Exports/TasksExport.php"
    click GenReportJob "https://github.com/enzob123/senff/blob/main/app/Jobs/GenerateTaskReportJob.php"
    click CreatedNotifJob "https://github.com/enzob123/senff/blob/main/app/Jobs/SendTaskCreatedNotificationJob.php"
    click CompletedNotifJob "https://github.com/enzob123/senff/blob/main/app/Jobs/SendTaskCompletedNotificationJob.php"
    click ReportEmailJob "https://github.com/enzob123/senff/blob/main/app/Jobs/SendReportReadyEmailJob.php"
    click GenericNotifJob "https://github.com/enzob123/senff/blob/main/app/Jobs/SendTaskNotification.php"
    click ReportReadyMail "https://github.com/enzob123/senff/blob/main/app/Mail/ReportReadyMail.php"
    click TaskCreatedMail "https://github.com/enzob123/senff/blob/main/app/Mail/TaskCreatedMail.php"
    click TaskCompletedMail "https://github.com/enzob123/senff/blob/main/app/Mail/TaskCompletedMail.php"
    click Migrations "https://github.com/enzob123/senff/tree/main/database/migrations"
    click Seeders "https://github.com/enzob123/senff/blob/main/database/seeders/DatabaseSeeder.php"
    click FileStorage "https://github.com/enzob123/senff/tree/main/storage/app"
    click PHPFPM "https://github.com/enzob123/senff/blob/main/bootstrap/app.php"
```
