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 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/
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.
When generating the docs for getprooph.org deployment you have to add an additional config to the root bookdown.json:
"rootHref": "http://getprooph.org/docs/html/",
. See bookdown.json.prod.
The docs are published under http://getprooph.org/docs/html
. Checkout the gh-pages
branch of prooph/proophessor and
copy the generated html into docs/html
of the gh-pages branch. Commit your changes and push the branch (write access required)
Try out proophessor-do and pick up a task!
- Ask questions on Stack Overflow tagged with #prooph.
- Say hello in the prooph gitter chat.
Happy messaging!