https://github.com/square-bit/laravel-workflow
https://github.com/square-bit/laravel-workflow
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/square-bit/laravel-workflow
- Owner: square-bit
- License: mit
- Created: 2023-08-11T14:46:33.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-06-16T16:00:15.000Z (7 months ago)
- Last Synced: 2025-06-16T16:59:05.257Z (7 months ago)
- Language: PHP
- Size: 68.4 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Add workflow support to your Laravel models.
[](https://packagist.org/packages/square-bit/laravel-workflow)
[](https://github.com/square-bit/laravel-workflow/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/square-bit/laravel-workflow/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://packagist.org/packages/square-bit/laravel-workflow)
Give your models the ability to flow through multiple states.
Features:
- default workflow per model class.
- parallel workflows: each model can transition if more than one workflow, in parallel,
- permissioned transitions.
## Installation
You can install the package via composer:
```bash
composer require square-bit/laravel-workflow
```
You can publish and run the migrations with:
```bash
php artisan vendor:publish --tag="laravel-workflow-migrations"
php artisan migrate
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag="laravel-workflow-config"
```
This is the contents of the published config file:
```php
return [
];
```
Optionally, you can publish the views using
```bash
php artisan vendor:publish --tag="laravel-workflow-views"
```
## Usage
```php
// TODO
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Squarebit, Lda](https://github.com/square-bit)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.