Skip to content
This repository was archived by the owner on Sep 18, 2020. It is now read-only.

brightmachine/EventLog

 
 

Repository files navigation

EventLog

What is EventLog?

EventLog is an append-only persistence layer to support Event Sourcing in your PHP project.

EventLog has the following defining characteristics:

  • doesn't overly enforce the use of objects, for example, if you want to push an event onto a stream without declaring an object for it, you can.
  • stores primitive types (strings, arrays) as JSON, will never resort to PHP serialisation of objects
  • will never attempt to rebuild an object itself, but will give the tools to make it easier

Requirements

PHP 5.5+

Installation

Install composer in your project:

curl -s http://getcomposer.org/installer | php

Create a composer.json file in your project root:

{
    "require": {
        "brightmachine/eventlog": "*"
    }
}

Install via composer:

php composer.phar install

License

EventLog is open-sourced software licensed under the MIT License - see the LICENSE file for details

Documentation

editing...

Contributing

Checkout master source code from github:

hub clone brightmachine/EventLog

Install development components via composer:

# If you don't have composer.phar
./scripts/bundle-devtools.sh .

# If you have composer.phar
composer.phar install --dev

Unit Testing

We works under test driven development.

Run phpspec:

./bin/phpspec run

Coding Standard

We follows coding standard PSR-2.

Check if your codes follows PSR-2 by phpcs:

./bin/phpcs --standard=PSR2 src/

Acknowledgement

We would like to acknowledge and thank…

About

Event sourcing persistence

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published