artisansdk/event

A foundational package for Event Sourcing (ES) using an Event Store database, compatible with Laravel.

dev-master 2023-07-10 18:59 UTC

Requires

• php: >=7.0 | >=8.0
• artisansdk/contract: dev-master
• illuminate/queue: ^5.0 | ^6.0 | ^7.0 | ^8.0 | ^9.0 | ^10.0
• illuminate/support: ^5.0 | ^6.0 | ^7.0 | ^8.0 | ^9.0 | ^10.0
• php-ds/php-ds: ^1.4

Requires (Dev)

• artisansdk/bench: dev-master

Suggests

• ext-ds: Install the Data Structure extension in order to speed up the event stream processing.

MIT

• Daniel LaBarge

README

A foundational package for Event Sourcing (ES) using an Event Store database, compatible with Laravel.

Table of Contents

• Installation
• Usage Guide
• Running the Tests
• Licensing

Installation

The package installs into a PHP application like any other PHP package:

composer require artisansdk/event

Usage Guide

The common use cases for this package should be documented including any troubleshooting.

Running the Tests

The package is unit tested with 100% line coverage and path coverage. You can run the tests by simply cloning the source, installing the dependencies, and then running ./vendor/bin/phpunit. Additionally included in the developer dependencies are some Composer scripts which can assist with Code Styling and coverage reporting:

composer test
composer watch
composer fix
composer report

See the composer.json for more details on their execution and reporting output. Note that composer watch relies upon watchman-make. Additionally composer report assumes a Unix system to run line coverage reporting. Configure the command setting the value for min = 80 to set your minimum line coverage requirements.

Licensing

Copyright (c) 2019-2023 Artisan Made

This package is released under the MIT license. Please see the LICENSE file distributed with every copy of the code for commercial licensing terms.