Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jorge07/symfony-6-es-cqrs-boilerplate

Symfony 6 DDD ES CQRS backend boilerplate.
https://github.com/jorge07/symfony-6-es-cqrs-boilerplate

backend cqrs cqrs-es ddd docker event-sourcing hacktoberfest symfony symfony-flex

Last synced: 5 days ago
JSON representation

Symfony 6 DDD ES CQRS backend boilerplate.

Host: GitHub
URL: https://github.com/jorge07/symfony-6-es-cqrs-boilerplate
Owner: jorge07
License: mit
Created: 2018-01-02T22:39:20.000Z (almost 7 years ago)
Default Branch: symfony-6
Last Pushed: 2024-07-18T11:41:13.000Z (6 months ago)
Last Synced: 2024-12-20T04:06:29.783Z (12 days ago)
Topics: backend, cqrs, cqrs-es, ddd, docker, event-sourcing, hacktoberfest, symfony, symfony-flex
Language: PHP
Homepage:
Size: 5.33 MB
Stars: 1,075
Watchers: 50
Forks: 187
Open Issues: 6
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Symfony 6 ES CQRS Boilerplate

[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-)

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

[![push](https://github.com/jorge07/symfony-6-es-cqrs-boilerplate/actions/workflows/push.yml/badge.svg)](https://github.com/jorge07/symfony-6-es-cqrs-boilerplate/actions/workflows/push.yml)

> This is a long living repository that started at v4 and was upgraded to each mayor since then. You can find v4 and v5 versions at the following branches:

> 

> [symfony-5 branch](https://github.com/jorge07/symfony-6-es-cqrs-boilerplate/tree/symfony-5)

>

> [symfony-4 branch](https://github.com/jorge07/symfony-6-es-cqrs-boilerplate/tree/symfony-4)

## Documentation

[Buses](https://github.com/jorge07/symfony-6-es-cqrs-boilerplate/tree/master/doc/GetStarted/Buses.md)

[Creating an Application Use Case](https://github.com/jorge07/symfony-6-es-cqrs-boilerplate/tree/master/doc/GetStarted/UseCases.md)

[Adding Projections](https://github.com/jorge07/symfony-6-es-cqrs-boilerplate/tree/master/doc/GetStarted/Projections.md)

[Async executions](https://github.com/jorge07/symfony-6-es-cqrs-boilerplate/tree/master/doc/GetStarted/Async.md)

[UI workflow](https://github.com/jorge07/symfony-6-es-cqrs-boilerplate/blob/master/doc/Workflow.md)

[Xdebug configuration](https://github.com/jorge07/symfony-6-es-cqrs-boilerplate/blob/master/doc/GetStarted/Xdebug.md)

[Kubernetes Deployment](https://github.com/jorge07/symfony-6-es-cqrs-boilerplate/blob/master/doc/Deployment.md)

## Architecture

![Architecture](https://i.imgur.com/SzHgMft.png)

## Implementations

- [x] Environment in Docker

- [x] Symfony Messenger

- [x] Event Store

- [x] Read Model

- [x] Async Event subscribers

- [x] Rest API

- [x] Web UI (A Terrible UX/UI)

- [x] Event Store Rest API 

- [x] Swagger API Doc

## Use Cases

#### User

- [x] Sign up

- [x] Change Email

- [x] Sign in

- [x] Logout

![API Doc](https://i.imgur.com/DBZsPlE.png)

## Stack

- PHP 8+

- Mysql 8.0

- Elastic & Kibana 7.11.0

- 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.](https://github.com/jorge07/alpine-php/blob/master/doc/IDE.md)

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](doc/docker-php-interpreter.png)

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

   

   ![Xdebug activation](doc/xdebug-activation.png)

   

   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](doc/xdebug-mapping.png)

   

   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](makefile)

> or specify its value on command line like `$ make start docker-os=windows`.

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
_Luis
💻

    
_Kajetan
💻

    
_{Krzysztof Kowalski}
💻

    
_{Patryk Woziński}
💻

    
_jon-ht
💻

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!