https://github.com/mguinea/laravel-ddd-example
Hexagonal Architecture + DDD + CQRS in PHP using Laravel 8
https://github.com/mguinea/laravel-ddd-example
best-practices bounded-context cqrs ddd docker domain-driven-design eloquent hexagonal-architecture laravel microservice modular monorepo php phpunit scalability testing
Last synced: about 1 month ago
JSON representation
Hexagonal Architecture + DDD + CQRS in PHP using Laravel 8
- Host: GitHub
- URL: https://github.com/mguinea/laravel-ddd-example
- Owner: mguinea
- Created: 2021-03-26T14:46:39.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-02T14:31:50.000Z (over 2 years ago)
- Last Synced: 2025-04-12T08:05:53.073Z (about 1 month ago)
- Topics: best-practices, bounded-context, cqrs, ddd, docker, domain-driven-design, eloquent, hexagonal-architecture, laravel, microservice, modular, monorepo, php, phpunit, scalability, testing
- Language: PHP
- Homepage:
- Size: 261 MB
- Stars: 88
- Watchers: 4
- Forks: 18
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
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](https://www.docker.com/get-started)
- [Install Docker Compose](https://docs.docker.com/compose/install/)
### 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](./kanban-api-endpoints.yaml)
Postman API collection [here](./kanban-api-endpoints.postman.json)
### 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](https://gist.github.com/leolorenzoluis/0aad69719267536d0b7a79946edbfcb7)
- [DDD Concepts](https://www.isaqb.org/blog/ddd-confusion-bounded-subdomain-context-module-or-what/)
- [Ansible best practices](https://docs.ansible.com/ansible/2.8/user_guide/playbooks_best_practices.html#content-organization)
- [Terraform first steps](https://www.adictosaltrabajo.com/2020/06/19/primeros-pasos-con-terraform-crear-instancia-ec2-en-aws/)
- [Jenkins in Docker](https://appinventiv.com/blog/jenkins-installation-using-docker-compose/)
- https://stackoverflow.com/questions/59643458/dockerfile-install-amqp-failed