README

📋 Overview

A modern Symfony 6.4 project skeleton built around Clean Architecture principles, specifically implementing the Hexagonal Architecture (also known as Ports and Adapters) pattern. This architecture isolates the core business logic from external concerns, making the system more maintainable, testable, and adaptable to change.

The project structure separates the core application from external dependencies:

The kernel lives in /src, isolated from your application code
Application and domain code lives in the /app folder, organized by bounded contexts
Infrastructure implementations connect the core to external systems and frameworks

This separation enables:

🔄 Swappable adapters (persistence, UI, services) without affecting business logic
🧪 Testable domain logic independent of infrastructure concerns
🛡️ Protection of business rules from external influence
🧩 Clear separation of concerns through well-defined ports (interfaces)

🏛️ Architecture

The project follows a Clean Architecture approach with the Hexagonal Architecture pattern (Ports and Adapters):

┌────────────────────────────────────────────────────┐
│                   Application                       │
│                                                     │
│   ┌─────────────────────────────────────────────┐  │
│   │              Domain Layer                    │  │
│   │                                             │  │
│   │  ┌─────────────────────────────────────┐   │  │
│   │  │                                     │   │  │
│   │  │         Business Logic              │   │  │
│   │  │                                     │   │  │
│   │  └─────────────────────────────────────┘   │  │
│   │                    │                        │  │
│   │                    ▼                        │  │
│   │  ┌─────────────────────────────────────┐   │  │
│   │  │            Application              │   │  │
│   │  │               Layer                 │   │  │
│   │  └─────────────────────────────────────┘   │  │
│   │                    │                        │  │
│   └────────────────────┼────────────────────────┘  │
│                        │                            │
│  ┌─────────────────────┼─────────────────────────┐ │
│  │     Infrastructure Layer (Adapters)           │ │
│  │                                               │ │
│  │  ┌────────────┐  ┌────────────┐ ┌──────────┐ │ │
│  │  │  Database  │  │    Web     │ │  Third   │ │ │
│  │  │  Adapter   │  │   Adapter  │ │  Party   │ │ │
│  │  └────────────┘  └────────────┘ └──────────┘ │ │
│  └───────────────────────────────────────────────┘ │
└────────────────────────────────────────────────────┘

Key Architectural Components:

Domain Layer: Contains business logic, entities, value objects, and domain services.
Application Layer: Contains use cases, application services, and ports (interfaces).
Infrastructure Layer: Contains adapters that implement the ports defined in the application layer.

🤖 InsideApps IA Context

This project includes InsideApps IA context for AI assistants. The InsideApps framework provides:

🔄 DDD Architectural Guidance: Clear guidelines for implementing Domain-Driven Design
🏗️ Automated Generation: Module and entity creation following DDD best practices
🤖 AI Integration: Specialized commands for AI assistants to understand the architecture
📏 Business Rule Enforcement: Consistent application of rules from the business-context directory
📝 Memory Protocol: Tracking of project changes and architectural decisions

InsideApps Commands:

# Load full architectural context
insideapps:start

# Create a new module with proper DDD structure
insideapps create new module <ModuleName>

# Create a new entity with business rules
insideapps create new entity <EntityName> in <ModuleName> with this rule: <BusinessRules>

For complete documentation, see the insideapps.md file.

✨ Features

🔐 Authentication System: Decoupled implementation for flexibility
🔑 Password Recovery: Decoupled password restoration system
🌐 API Support: Built-in API capabilities with documentation
📊 Monolog Integration: Comprehensive logging
🎨 PlaniAdmin Template: Modern admin interface integration
🚀 Automated Deployment: Integrated with Deployer for streamlined deployments

🚀 Installation

Clone the repository
Install dependencies:
```
composer install
```
Create a .env.local file in the config/env folder
Configure your database connection and mailer DSN

Run database migrations:

php bin/console doctrine:migrations:migrate

Start the development server:
```
symfony server:start
```

🚢 Deployment

This project uses Deployer for automated deployments to staging and production environments.

Quick Deployment Commands

# Deploy to production
vendor/bin/dep deploy production

# Deploy to staging
vendor/bin/dep deploy staging

# Rollback to previous version if needed
vendor/bin/dep rollback production

For detailed deployment instructions and configuration, please refer to the deployment documentation.

🔗 Routes

🔒 /login - Authentication page
📚 /api/docs - API Documentation

📚 Documentation

For more detailed documentation on the architecture and development guidelines, please refer to:

insideapps.md - InsideApps AI context and architectural guidelines
business-context/ directory - Business rules and domain models
deploy/README.md - Deployment configuration and instructions

insideapps / application

Maintainers

Details