prooph / event-store-flywheel-adapter
Flywheel Adapter for ProophEventStore
Requires
- php: ^5.5 || ^7.0
- jamesmoss/flywheel: ^0.4.2
- prooph/common: ^3.5
- prooph/event-store: ^6.0
Requires (Dev)
- container-interop/container-interop: ^1.1
- fabpot/php-cs-fixer: ^1.10
- phpunit/phpunit: ^4.8 || ^5.2
- sandrokeil/interop-config: ^1.0
- satooshi/php-coveralls: ^1.0
Suggests
- container-interop/container-interop: For usage of provided factories
- sandrokeil/interop-config: For usage of provided factories
Conflicts
This package is auto-updated.
Last update: 2024-10-17 02:06:04 UTC
README
Use Prooph Event Store with Flywheel.
Overview
Flywheel is a serverless document database which only uses flat files on your local filesystem to store the data. All the events will be stored and loaded from a choosen directory. This is well suited when you bootstrap an application and you don't need a real database server right away. It can also be a good candidate for writing functionnal tests.
But of course you must not run it in production since it is not designed to handle a huge amount of events and doesn't manage transactions.
Installation
You can install this package via Composer:
composer require prooph/event-store-flywheel-adapter
Usage
See the quickstart example.
It creates some events and store them in JSON files in the quickstart/event_store
directory.
Here is an example of a created JSON file:
{ "event_id": "4e5bba37-e2bb-46d3-9988-e2ec6b02e664", "version": 1, "event_name": "ProophTest\\EventStore\\Mock\\UserCreated", "payload": { "name": "Max Mustermann" }, "metadata": { "tag": "person" }, "created_at": "2016-02-25T13:28:54.365200" }
Support
- File issues at https://github.com/prooph/event-store-flywheel-adapter/issues.
- Say hello in the prooph gitter chat.
Contribute
Please feel free to fork, extend existing and send a pull request with your changes!
To establish a consistent code quality, please provide unit tests for all your changes.
You are also encouraged to use the composer lint
command to validate the coding standards.
License
Released under the New BSD License.