Hexagonal Architecture, DDD & CQRS in Laravel PHP

This is a monorepo containing a PHP application using Domain-Driven Design (DDD) and Command Query Responsibility Segregation (CQRS) principles.

It's a basic implementation of a Kanban manager (at this moment, just only manages Board entity with id and name attributes)

The main objective of this implementation is to use Laravel as backend framework but instead of using MVC architecture, go for DDD and Hexagonal.

Report a bug · Request a feature

Installation

Requirements

• Install Docker
• Install Docker Compose

Environment

• Clone this project: git clone https://github.com/mguinea/laravel-ddd-example laravel-ddd-example
• Move to the project folder: cd laravel-ddd-example

Execution

Install all the dependencies and bring up the project with Docker executing:

make build
make up
make migrate

Then you'll have 1 app available (an API):

• Kanban API: http://localhost:8080/api/v1/kanban/health-check

API Documentation

Open API documentation here

Postman API collection here

Tests

Execute all test suites: make tests

Project structure and explanation

Root Folders

apps

Here are our implementations of the code we have in our base (src). Here can be any framework, etc...

etc

etc is for "Editable Text Configurations". So here we can put any configuration by xml, yaml etc... like Docker setup.

src

src is for "Source". Here we put all our code base being as independent as possible of any implementation (except is there is in infrastructure subfolder).

Bounded contexts

Kanban: Place where the main functionality is implemented. Management of boards...

Architecture and Structure

This repository follows the Hexagonal Architecture pattern. Also, it's structured using modules. With this, we can see that the current structure:

Kanban bounded context containing Board module and Shared bonded context.

$ tree -L 3 src

src
├── Kanban
│   └── Board
│       ├── Application
│       ├── Domain
│       └── Infrastructure
└── Shared
    ├── Domain
    │   ├── Aggregate
    │   └── Bus
    └── Infrastructure
        └── Bus

Repositories

Repository pattern

Our repositories try to be as simple as possible usually only containing basic CRUD methods (delete, find, save and list using criteria pattern).

CQRS

Symfony Messenger has been used to implement commands, queries and events.

Infrastructure

RabbitMQ

There is a service with RabbitMQ to manage queues. You can access it going to http://localhost:15672 and using guest as username and password.

References

• Bash best practices
• DDD Concepts
• Ansible best practices
• Terraform first steps
• Jenkins in Docker
• https://stackoverflow.com/questions/59643458/dockerfile-install-amqp-failed