# sylius/syliusdemo architecture

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

- Interactive diagram: https://gitdiagram.com/sylius/syliusdemo
- Repository: https://github.com/sylius/syliusdemo

## Overview

##### Main Components

a. Frontend Layer:
- Admin Panel (assets/admin)
- Shop Frontend (assets/shop)
- Template System (templates directory)
- Webpack/Asset Management

b. Backend Layer:
- Symfony Application Core
- API Platform Integration
- Controllers Layer
- Entity Layer
- Repository Layer
- Event Listeners
- Service Layer

c. Infrastructure:
- Database (Doctrine ORM)
- Message Queue (Messenger)
- Caching Layer
- JWT Authentication
- File Storage

##### Key Relationships to Highlight

**[Client Browsers] → [Load Balancer/Web Server]**
- ↓
**[Frontend Layer] ←→ [API/Controller Layer]**
- ↓
**[Service Layer] ←→ [Event System]**
- ↓                       ↓
**[Entity Layer] ←→ [Repository Layer]**
- ↓
**[Database Layer]**

##### Specific Implementation Details

- Blue rectangles: Core components
- Green hexagons: External services
- Yellow diamonds: Security checkpoints
- Orange circles: Event listeners
- Purple rectangles: Template/Asset management

##### Additional Elements

Supporting components:
- Testing infrastructure (Behat/PHPSpec)
- Development tools
- Monitoring systems
- Cache layers
- Message queue system

##### Important Notations

Specific callouts:
- API Platform endpoints
- Sylius-specific components
- Custom implementations
- Third-party integrations
- Database relationships

- The decoupled nature of the platform
- Clear separation between admin and shop interfaces
- Event-driven architecture
- RESTful API structure
- Security implementation
- Scalability points

Remember to:
- Keep components grouped logically
- Use consistent naming conventions
- Version information
- Document integration points
- Data flow directions clearly

This system design should reflect Sylius's modular architecture while showing how custom implementations (visible in src/ directory) integrate with the core platform.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Client
        Browser["Web Browsers"]
        APIConsumers["API Consumers"]
    end

    subgraph WebServer["Web/Application Server"]
        LoadBalancer["Load Balancer"]
        SecurityLayer["Security Layer"]:::security
    end

    subgraph FrontendLayer["Frontend Layer"]
        AdminPanel["Admin Panel"]:::frontend
        ShopFrontend["Shop Frontend"]:::frontend
        TemplateSystem["Template System"]:::frontend
        AssetManagement["Asset Management"]:::frontend
    end

    subgraph ApplicationCore["Application Core"]
        APILayer["API Platform"]:::core
        Controllers["Controllers Layer"]:::core
        ServiceLayer["Service Layer"]:::core
        EventSystem["Event System"]:::event
    end

    subgraph DataLayer["Data Layer"]
        EntityLayer["Entity Layer"]:::data
        RepositoryLayer["Repository Layer"]:::data
        ProductEntity["Product Entity"]:::data
    end

    subgraph Infrastructure["Infrastructure Services"]
        Database[(Database)]:::infra
        MessageQueue["Message Queue"]:::infra
        Cache["Cache Layer"]:::infra
        FileStorage["File Storage"]:::infra
    end

    subgraph Testing["Testing Infrastructure"]
        Behat["Behat Tests"]:::test
        PHPSpec["PHPSpec Tests"]:::test
    end

    %% Relationships
    Browser --> LoadBalancer
    APIConsumers --> LoadBalancer
    LoadBalancer --> SecurityLayer
    SecurityLayer --> FrontendLayer
    SecurityLayer --> APILayer

    AdminPanel --> Controllers
    ShopFrontend --> Controllers
    TemplateSystem --> Controllers

    APILayer --> ServiceLayer
    Controllers --> ServiceLayer
    ServiceLayer --> EventSystem
    ServiceLayer --> EntityLayer
    EntityLayer --> RepositoryLayer
    RepositoryLayer --> Database
    EventSystem --> MessageQueue
    ServiceLayer --> Cache
    ServiceLayer --> FileStorage

    %% Click Events
    click AdminPanel "https://github.com/Sylius/SyliusDemo/tree/2.0/assets/admin"
    click ShopFrontend "https://github.com/Sylius/SyliusDemo/tree/2.0/assets/shop"
    click TemplateSystem "https://github.com/Sylius/SyliusDemo/tree/2.0/templates/"
    click AssetManagement "https://github.com/Sylius/SyliusDemo/blob/2.0/webpack.config.js"
    click Controllers "https://github.com/Sylius/SyliusDemo/tree/2.0/src/Controller"
    click EntityLayer "https://github.com/Sylius/SyliusDemo/tree/2.0/src/Entity"
    click RepositoryLayer "https://github.com/Sylius/SyliusDemo/tree/2.0/src/Repository"
    click EventSystem "https://github.com/Sylius/SyliusDemo/tree/2.0/src/EventListener"
    click APILayer "https://github.com/Sylius/SyliusDemo/tree/2.0/config/api_platform"
    click Database "https://github.com/Sylius/SyliusDemo/blob/2.0/config/packages/doctrine.yaml"
    click MessageQueue "https://github.com/Sylius/SyliusDemo/blob/2.0/config/packages/messenger.yaml"
    click SecurityLayer "https://github.com/Sylius/SyliusDemo/blob/2.0/config/packages/security.yaml"
    click ProductEntity "https://github.com/Sylius/SyliusDemo/blob/2.0/src/Entity/Product/Product.php"
    click Behat "https://github.com/Sylius/SyliusDemo/tree/2.0/tests/Behat"
    click PHPSpec "https://github.com/Sylius/SyliusDemo/tree/2.0/spec/"

    %% Styles
    classDef frontend fill:#9ca3af
    classDef core fill:#60a5fa
    classDef data fill:#34d399
    classDef infra fill:#818cf8
    classDef security fill:#fcd34d
    classDef event fill:#fb923c
    classDef test fill:#e879f9

    %% Legend
    subgraph Legend
        Frontend["Frontend Components"]:::frontend
        Core["Core Components"]:::core
        Data["Data Components"]:::data
        Infra["Infrastructure"]:::infra
        Security["Security Components"]:::security
        Event["Event Components"]:::event
        Test["Testing Components"]:::test
    end
```
