README

🚧 Currently under heavy construction

Undergoing massive slimming process and quality of life improvements. Some may be overkill, others sound reasonable, but will be hard nonetheless. Any help would be greatly appreciated, so we can get here at some point. 🥲

Introduction

Are you sick of inconsistently reimplementing related business processes for your clients?

Do you want to find a common solution which is easy to build and maintain?

Look no more.

This package aims to ease your pain when implementing related business processes / workflows in Laravel. Right now it uses DAG structure for flow relations.

General idea

Example flows

Client project lifecycle (proposal, contract, deposit, development, feedback, ...)
Multipart forms of any sorts
Basically any process which can be split into smaller, logical pieces

Documentation

Installation

⛔ do not install, without a documentation it's a mess. Wait till v1.

If you still wanna proceeed, you can install the package via composer:

composer require dystcz/flow

The package will automatically register itself (wow).

You can publish the migration with:

php artisan vendor:publish --provider="Dystcz\Flow\FlowServiceProvider" --tag="migrations"

After publishing the migration you can create the tables by running the migrations:

php artisan migrate

You can optionally publish the config file with:

php artisan vendor:publish --provider="Dystcz\Flow\FlowServiceProvider" --tag="config"

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email jakub@dy.st instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

dystcz / flow

Maintainers

Details