Skip to content

Latest commit

 

History

History
117 lines (74 loc) · 4.02 KB

README.md

File metadata and controls

117 lines (74 loc) · 4.02 KB
Raw

Symfony 5 ES CQRS Boilerplate

A boilerplate for DDD, CQRS, Event Sourcing applications using Symfony as framework and running with php7

push Coverage Status

Symfony 4 still available in symfony-4 branch

Documentation

Buses

Creating an Application Use Case

Adding Projections

Async executions

UI workflow

Xdebug configuration

Kubernetes Deployment

Architecture

Architecture

Implementations

  • Environment in Docker
  • Symfony Messenger
  • Event Store
  • Read Model
  • Async Event subscribers
  • Rest API
  • Web UI (A Terrible UX/UI)
  • Event Store Rest API
  • Swagger API Doc

Use Cases

User

  • Sign up
  • Change Email
  • Sign in
  • Logout

API Doc

Stack

  • PHP 7.4
  • Mysql 8.0
  • Elastic & Kibana 7.6
  • RabbitMQ 3

Project Setup

Action Command
Setup make start
Run Tests make phpunit
Static Analisys make style
Code Style make cs
Code style check make cs-check
PHP Shell make s=php sh
Xdebug make xoff/xon
Build Artifacts make artifact

PHPStorm integration

PHPSTORM has native integration with Docker compose. That's nice but will stop your php container after run the test scenario. That's not nice when using fpm. A solution could be use another container just for that purpose but is way slower and I don't want. For that reason I use ssh connection.

IMPORTANT

ssh in the container it's ONLY for that reason and ONLY in the DEV TAG, if you've ssh installed in your production container, you're doing it wrong...*

Click here for the detailed instructions about how to setup the PHP remote interpreter in PHPStorm.

If you're already familiar with it, here a quick configuration reference:

Host Direction
Docker 4 mac localhost
Dinghy $ dinghy ip

Port: 2323

Filesystem mapping: {PROJECT_PATH} -> /app

Xdebug

To ease your development process, you can use Xdebug with PHPSTORM.

  1. Add a Docker interpreter

    Docker PHP interpreter

  2. Enable Xdebug listenning. Don't forget to also activate Xdebug helper from your browser.

    Xdebug activation

    Additionally, you can check Break at first line in PHP scripts to ensure your debug is working.

  3. Make a request from you API at http://127.0.0.1/api/doc for example. You should see this popup:

    Xdebug mapping

    Click on Accept and you should be ready to debug ! Start placing breakpoints on your code and enjoy debugging !

Note for Windows users:

You might need to update docker-os= to docker-os=windows in Makefile or specify its value on command line like $ make start docker-os=windows.