Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clementvtrd/boilerplate-hexagonal
A boilerplate with an hexagonal CQRS Symfony base project
https://github.com/clementvtrd/boilerplate-hexagonal
boilerplate cqrs-pattern docker hexagonal-architecture symfony
Last synced: 18 days ago
JSON representation
A boilerplate with an hexagonal CQRS Symfony base project
- Host: GitHub
- URL: https://github.com/clementvtrd/boilerplate-hexagonal
- Owner: clementvtrd
- License: mit
- Created: 2022-08-04T17:01:13.000Z (over 2 years ago)
- Default Branch: develop
- Last Pushed: 2024-06-07T04:57:21.000Z (5 months ago)
- Last Synced: 2024-06-09T06:01:21.915Z (5 months ago)
- Topics: boilerplate, cqrs-pattern, docker, hexagonal-architecture, symfony
- Language: PHP
- Homepage:
- Size: 3.74 MB
- Stars: 13
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://github.com/clementvtrd/boilerplate-hexagonal/actions/workflows/api.yaml)
# Hexagonal boilerplate
## Hexagonal architecture
The hexagonal architecture is a software architectural pattern that promotes a clear separation of concerns and decoupling of components. It emphasizes the idea of organizing an application into concentric layers, with the core business logic at the center, surrounded by layers representing external interfaces, such as UI, databases, and external services.
In the hexagonal architecture, the core business logic is independent of the external infrastructure and frameworks. It is encapsulated within the innermost layer and is unaware of how the application interacts with external systems. Instead, the external systems are abstracted through interfaces called "ports." Adapters are responsible for implementing these ports and bridging the gap between the core business logic and the external systems.
This architecture enables better testability, maintainability, and flexibility. It allows for easy swapping of external components, as long as they adhere to the defined ports' interfaces. Changes in the external systems do not impact the core business logic, making the application more resilient to modifications and evolutions.
Overall, the hexagonal architecture promotes a modular, clean, and adaptable design by separating concerns and dependencies, leading to a more robust and maintainable software system..
## Stack
This boilerplate is built with Symfony for learning purpose. You can replace each part at your convenience.
We will use Docker to make a development environment with 5 services:
- Traefik: as a reverse proxy
- Nginx + PHP: serves the Symfony API
- MySQL: to store our data
- RabbitMQ: messaging queue system (in pair with Symfony Messenger)
- Node: develop, build and serve NextJS application
## Installation
### Docker
This boilerplate was built around with [Orbstack](https://orbstack.dev) (which can replace Docker Desktop on MacOS).
### Taskfile
The project uses [Taskfile](https://taskfile.dev/) to create CLI shortcuts. You can install it via its website, they also provide a convenient script to install it on common systems:
#### Linux
```sh
sudo sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b /usr/local/bin
task
```
#### MacOS
```sh
brew install go-task
task
```
#### Windows
```sh
winget install Task.Task # you may need to restart your session
task
```
## Commands
| Task | Description |
|----------|-----------------------------------------------------------|
| start | Start the Docker containers detached |
| stop | Stop the Docker containers |
| install | Build and pull images, setup SSL and install dependencies |
| symfony | Shortcut to interact with Symfony CLI |
| composer | Shortcut to run Composer commands |
| console | Shortcut to interact with bin/console script |
| phpstan | Shortcut to run PHP Stan |
| deptrac | Shortcut to run Deptrac |
| cs-fixer | Shortcut to run PHP CS Fixer |
| rector | Shortcut to run Rector |
| phpspec | Shortcut to run PhpSpec |
## URLs
- [NextJS frontend](https://app.localhost)
- [Symfony API](https://api.app.localhost)
- [Traefik dashboard](https://traefik.app.localhost)
- [Rabbit MQ monitor](https://rabbitmq.app.localhost)