README

Flowstone is a powerful Laravel package that integrates the robust Symfony Workflow engine into your Laravel applications. Build sophisticated workflow and state machine systems with database-driven configurations, role-based permissions, and seamless Laravel integration.

🚀 Key Features

• 🔄 Database-Driven Workflows - Configure workflows through the database for runtime flexibility
• 🏛️ Symfony Workflow Integration - Built on the proven Symfony Workflow component
• 👥 Role-Based Permissions - Control who can perform transitions with metadata-driven roles
• 📊 Predefined Status Enum - Ready-to-use workflow states (Draft, Pending, Approved, etc.)
• ⚡ Performance Optimized - Workflow configuration caching and efficient queries
• 🎯 Multiple Workflow Types - Support for both State Machines and Workflows

Table of Contents

• Installation
• Documentation
• Examples
• Testing
• Contributing
• License

Installation

Install Flowstone via Composer:

composer require cleaniquecoders/flowstone

Publish and run the migrations:

php artisan vendor:publish --tag="flowstone-migrations"
php artisan migrate

Optionally, publish the configuration file:

php artisan vendor:publish --tag="flowstone-config"

Documentation

Comprehensive documentation is available in the docs/ directory:

• Getting Started
  • Installation Guide - Detailed setup instructions
  • Quick Start Guide - Get up and running quickly
• Configuration Reference - Complete configuration options
• Usage Guide - Detailed usage instructions
• API Reference - Complete API documentation

Examples

Real-world examples are available in the examples/ directory:

1. Document Approval - Classic approval process with roles
2. E-commerce Orders - Order lifecycle management
3. Content Publishing - Editorial workflow with scheduling
4. Bug Tracking - Issue management for development teams
5. Employee Onboarding - HR workflow with multi-department coordination

Each example includes complete implementation with models, controllers, views, and tests.

Testing

composer test

Contributing

Please see CONTRIBUTING for details.

License

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