README

Exploring prooph components

Welcome at prooph! We are developing and supporting CQRS and EventSourcing infrastructure for PHP 7.1+ environments. prooph is NOT a framework. Instead we provide components which address individual topics.

Documentation

Documentation is in the docs tree, and can be compiled using bookdown and Docker.

$ docker run --rm -it -v $(pwd):/app prooph/composer:7.1
$ docker run -it --rm -e CSS_BOOTSWATCH=lumen -e CSS_PRISM=ghcolors -v $(pwd):/app sandrokeil/bookdown:develop docs/bookdown.json
$ docker run -it --rm -p 8080:8080 -v $(pwd):/app php:7.1-cli php -S 0.0.0.0:8080 -t /app/docs/html

Then browse to http://localhost:8080/

Remote Docs

We use the remote content feature of bookdown to pull docs from our prooph component repos into a single online documentation. This means that if you want to work on the docs - fix spelling, add new pages, improve wording or correct some logical bugs - then take a look at the root bookdown.json to see where the docs are pulled from. Head over to the target repository and apply your changes there. Send us a pull request and we manage the rest. Thank you for your help.

Docs Maintenance/Deployment (maintainers only)

Compiled docs (using docker cmd above) are managed in an extra repo prooph/docs. The repo README contains deployment instructions.

Example Application

Try out proophessor-do and pick up a task!

Support

Ask questions on Stack Overflow tagged with #prooph.
Say hello in the prooph gitter chat.

Happy messaging!

prooph / proophessor

Maintainers

Details