# badr-eddine-slaoui/piano-competition architecture

> Architecture diagram of the GitHub repository badr-eddine-slaoui/piano-competition, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-10-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/badr-eddine-slaoui/piano-competition
- Repository: https://github.com/badr-eddine-slaoui/piano-competition

## Overview

##### Project Type and Purpose
- This is a full-stack Laravel MVC web application that powers a dual event site (Marrakech and Paris) with pages for welcome, contact, inscription, reservations, galleries, committees, jury, partners, etc.
- The application serves dynamic content via Blade templates, handles form submissions, interacts with a SQL database via Eloquent ORM, runs console commands (e.g., sitemap generation), and manages assets (CSS, JS, images, videos).

##### File Structure Analysis
- Top-level directories:
- app – contains MVC logic: Controllers, Requests (validation), Models, Console commands, Service Providers.
- bootstrap, config – application bootstrap and configuration.
- database – migrations, factories, seeders.
- public – web-root for index.php, static assets (Images, Videos, robots.txt).
- resources – front-end source files: Blade views, CSS, JS, fonts.
- routes – route definitions (web, console).
- storage – runtime files (logs, cache, sessions, compiled views).
- tests – automated Feature and Unit tests.
- Patterns:
- MVC (Models in app/Models, Controllers in app/Http/Controllers, Views in resources/views).
- Form-request validation layer (app/Http/Requests).
- Eloquent Schema migrations for DB tables.
- Console command for generating sitemap.

##### README Insights
- Generic Laravel README confirms usage of Laravel features: routing, DI container, Eloquent ORM, migrations, queues, broadcasting.

a. Main Components
- Client (Web Browser)
- Web Server (Apache/Nginx) + PHP-FPM
- Laravel Application
- Relational Database (MySQL/PostgreSQL)
- File Storage (local disk, optional S3)
- Queue Worker (for background jobs)
- Mail Service (SMTP or external like Mailgun)
- (Optional) Cache/Session Store (Redis, Memcached)
b. Relationships & Data Flow
- Client ↔ Web Server ↔ Laravel router ↔ Controller ↔ Model ↔ Database
- Controller ↔ Blade Views → HTML/CSS/JS → Client
- Public assets (images, videos, CSS, JS) served directly by Web Server from public/
- Form requests validated by Request classes before reaching Controller
- Console scheduling or manual execution triggers GenerateSitemap command (reads DB → writes sitemap.xml to public/)
- Background jobs enqueued by Controllers → processed by Queue Worker (e.g., sending emails via Mail Service)
- Cache/Session reads & writes via Laravel Cache/Session config to Redis or database table
c. Architectural Patterns & Principles
- MVC separation of concerns
- Dependency Injection via Service Providers
- Single Responsibility in Request classes
- Event-Driven or Queue‐Based asynchronous processing
- Database Migrations for versioned schema
- Asset compilation (Vite/Tailwind/PostCSS) for front-end build
d. Key Technologies & Libraries
- PHP 8.x, Laravel Framework
- Blade templating engine
- Eloquent ORM
- Vite or Mix for asset bundling
- Tailwind CSS (via tailwind.config.js)
- PHPUnit for tests
- Queue driver (Redis or database jobs)
- Mail driver (SMTP, Mailgun, etc.)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Client Layer
    subgraph "Client Layer"
        Browser["Web Browser"]:::client
    end

    %% Web Server Layer
    subgraph "Web Server"
        entry["public/index.php"]:::server
        assets["Static Assets (public/Images & Videos)"]:::storage
    end

    %% Laravel Application Core
    subgraph "Laravel Application"
        bootstrap["bootstrap/app.php"]:::app
        config["Configuration Files"]:::config
        env["Environment (.env)"]:::config
        routesHTTP["routes/web.php"]:::routes
        routesConsole["routes/console.php"]:::routes
        provider["AppServiceProvider"]:::app

        %% MVC Components
        subgraph "MVC Core"
            subgraph "Controllers"
                mController["MarrakechController"]:::controller
                mContactC["MarrakechContactController"]:::controller
                mInsC["MarrakechInscriptionController"]:::controller
                mResC["MarrakechReservationController"]:::controller
                pController["ParisController"]:::controller
                pContactC["ParisContactController"]:::controller
                pInsC["ParisInscriptionController"]:::controller
                pResC["ParisReservationController"]:::controller
            end
            subgraph "Form Requests"
                mContactR["MarrakechContactRequest"]:::request
                mInsR["MarrakechInscriptionRequest"]:::request
                mResR["MarrakechReservationRequest"]:::request
                pContactR["ParisContactRequest"]:::request
                pInsR["ParisInscriptionRequest"]:::request
                pResR["ParisReservationRequest"]:::request
            end
            subgraph "Models"
                mContactM["MarrakechContact Model"]:::model
                mInsM["MarrakechInscription Model"]:::model
                mResM["MarrakechReservation Model"]:::model
                pContactM["ParisContact Model"]:::model
                pInsM["ParisInscription Model"]:::model
                pResM["ParisReservation Model"]:::model
                userM["User Model"]:::model
            end
            subgraph "Views"
                layouts["Layouts & Page Templates"]:::view
                homeView["index.blade.php"]:::view
            end
        end

        migrations["database/migrations"]:::storage
        factories["database/factories & seeders"]:::storage
        commands["GenerateSitemap Command"]:::console
        queue["Queue Worker"]:::worker
        mail["Mail Service (SMTP/Mailgun)"]:::external
        cache["Cache/Session Store"]:::cache
        artisan["Artisan CLI"]:::tool
    end

    %% Persistence & Storage
    db["Relational Database"]:::database
    storageLocal["File Storage (storage/)"]:::storage

    %% Connections - Synchronous Flows
    Browser -->|"HTTP Request"| entry
    entry --> bootstrap
    bootstrap --> config
    bootstrap --> env
    bootstrap --> routesHTTP
    bootstrap --> routesConsole
    routesHTTP --> provider
    provider --> mController
    provider --> pController

    %% Request Validation
    mContactR --> mContactC
    mInsR --> mInsC
    mResR --> mResC
    pContactR --> pContactC
    pInsR --> pInsC
    pResR --> pResC

    %% Controller to Request and Models
    mController -->|"calls"| mContactR
    mController -->|"calls"| mInsR
    mController -->|"calls"| mResR
    pController -->|"calls"| pContactR
    pController -->|"calls"| pInsR
    pController -->|"calls"| pResR

    mContactR --> mContactM
    mInsR --> mInsM
    mResR --> mResM
    pContactR --> pContactM
    pInsR --> pInsM
    pResR --> pResM

    %% Models to Database
    mContactM -->|CRUD| db
    mInsM -->|CRUD| db
    mResM -->|CRUD| db
    pContactM -->|CRUD| db
    pInsM -->|CRUD| db
    pResM -->|CRUD| db
    userM -->|CRUD| db

    %% Views Rendering
    mController --> layouts
    pController --> layouts
    layouts --> homeView
    homeView -->|"HTML/CSS/JS"| Browser

    %% Static Assets
    assets -->|"served directly"| Browser

    %% Background Processes
    mController -->|"enqueue jobs"| queue
    pController -->|"enqueue jobs"| queue
    queue --> mail
    queue --> cache

    %% Console & CLI
    routesConsole --> commands
    commands --> migrations
    commands --> db
    commands --> storageLocal
    artisan --> commands

    %% Persistence Stores
    db -->|"reads/writes"| cache
    storageLocal -->|"stores files"| application

    %% Click Events
    click entry "https://github.com/badr-eddine-slaoui/piano-competition/blob/main/public/index.php"
    click assets "https://github.com/badr-eddine-slaoui/piano-competition/tree/main/public/Images/"
    click bootstrap "https://github.com/badr-eddine-slaoui/piano-competition/blob/main/bootstrap/app.php"
    click config "https://github.com/badr-eddine-slaoui/piano-competition/blob/main/config/app.php"
    click routesHTTP "https://github.com/badr-eddine-slaoui/piano-competition/blob/main/routes/web.php"
    click routesConsole "https://github.com/badr-eddine-slaoui/piano-competition/blob/main/routes/console.php"
    click commands "https://github.com/badr-eddine-slaoui/piano-competition/blob/main/app/Console/Commands/GenerateSitemap.php"
    click provider "https://github.com/badr-eddine-slaoui/piano-competition/blob/main/app/Providers/AppServiceProvider.php"
    click mController "https://github.com/badr-eddine-slaoui/piano-competition/blob/main/app/Http/Controllers/MarrakechController.php"
    click mContactC "https://github.com/badr-eddine-slaoui/piano-competition/blob/main/app/Http/Controllers/MarrakechContactController.php"
    click mInsC "https://github.com/badr-eddine-slaoui/piano-competition/blob/main/app/Http/Controllers/MarrakechInscriptionController.php"
    click mResC "https://github.com/badr-eddine-slaoui/piano-competition/blob/main/app/Http/Controllers/MarrakechReservationController.php"
    click pController "https://github.com/badr-eddine-slaoui/piano-competition/blob/main/app/Http/Controllers/ParisController.php"
    click pContactC "https://github.com/badr-eddine-slaoui/piano-competition/blob/main/app/Http/Controllers/ParisContactController.php"
    click pInsC "https://github.com/badr-eddine-slaoui/piano-competition/blob/main/app/Http/Controllers/ParisInscriptionController.php"
    click pResC "https://github.com/badr-eddine-slaoui/piano-competition/blob/main/app/Http/Controllers/ParisReservationController.php"
    click mContactR "https://github.com/badr-eddine-slaoui/piano-competition/blob/main/app/Http/Requests/MarrakechContactRequest.php"
    click mInsR "https://github.com/badr-eddine-slaoui/piano-competition/blob/main/app/Http/Requests/MarrakechInscriptionRequest.php"
    click mResR "https://github.com/badr-eddine-slaoui/piano-competition/blob/main/app/Http/Requests/MarrakechReservationRequest.php"
    click pContactR "https://github.com/badr-eddine-slaoui/piano-competition/blob/main/app/Http/Requests/ParisContactRequest.php"
    click pInsR "https://github.com/badr-eddine-slaoui/piano-competition/blob/main/app/Http/Requests/ParisInscriptionRequest.php"
    click pResR "https://github.com/badr-eddine-slaoui/piano-competition/blob/main/app/Http/Requests/ParisReservationRequest.php"
    click mContactM "https://github.com/badr-eddine-slaoui/piano-competition/blob/main/app/Models/MarrakechContact.php"
    click mInsM "https://github.com/badr-eddine-slaoui/piano-competition/blob/main/app/Models/MarrakechInscription.php"
    click mResM "https://github.com/badr-eddine-slaoui/piano-competition/blob/main/app/Models/MarrakechReservation.php"
    click pContactM "https://github.com/badr-eddine-slaoui/piano-competition/blob/main/app/Models/ParisContact.php"
    click pInsM "https://github.com/badr-eddine-slaoui/piano-competition/blob/main/app/Models/ParisInscription.php"
    click pResM "https://github.com/badr-eddine-slaoui/piano-competition/blob/main/app/Models/ParisReservation.php"
    click userM "https://github.com/badr-eddine-slaoui/piano-competition/blob/main/app/Models/User.php"
    click layouts "https://github.com/badr-eddine-slaoui/piano-competition/blob/main/resources/views/Layouts/marrakech-container.blade.php"
    click homeView "https://github.com/badr-eddine-slaoui/piano-competition/blob/main/resources/views/index.blade.php"

    %% Styles
    classDef client fill:#D5E8D4,stroke:#82B366
    classDef server fill:#FFF2CC,stroke:#D6B656
    classDef app fill:#E1D5E7,stroke:#9673A6
    classDef config fill:#F8CECC,stroke:#B85450
    classDef routes fill:#FFE6CC,stroke:#D99B66
    classDef controller fill:#DAE8FC,stroke:#6C8EBF
    classDef request fill:#E1F5A9,stroke:#82B366
    classDef model fill:#F5F5F5,stroke:#999999
    classDef view fill:#FFF2CC,stroke:#D6B656
    classDef storage fill:#E1D5E7,stroke:#9673A6
    classDef console fill:#F8F8F8,stroke:#BBBBBB
    classDef worker fill:#E6E6FA,stroke:#A9A9F5
    classDef external fill:#FFE6E6,stroke:#D96666
    classDef cache fill:#E1F5A9,stroke:#82B366
    classDef database fill:#DAE8FC,stroke:#6C8EBF
    classDef tool fill:#F5F5F5,stroke:#999999
```
