Home

🚀 Laravel Flowpipe

A modern, YAML-driven workflow engine for Laravel applications

Laravel Flowpipe transforms complex business processes into simple, readable YAML files. Define your workflows declaratively and let Laravel Flowpipe handle the execution, error handling, and tracing.

🌟 Why Laravel Flowpipe?

• 📄 YAML-First: Define workflows in simple, readable YAML files
• 🔄 Composable: Reuse steps and groups across different flows
• 🎯 Type-Safe: Full PHP class integration with Laravel's IoC container
• 🚨 Error Handling: Built-in retry, fallback, and compensation strategies
• 📊 Traceable: Complete execution tracking and debugging
• ⚡ Queue Support: Seamless Laravel queue integration

⚡ Quick Start

1. Install the Package

composer require grazulex/laravel-flowpipe

2. Create Your First YAML Flow

# flows/user-registration.yaml
flow: user-registration
description: Complete user registration process

send:
  name: "John Doe"
  email: "[email protected]"
  password: "SecurePassword123!"

steps:
  - type: action
    class: App\Flowpipe\Steps\ValidateInputStep
    
  - type: action
    class: App\Flowpipe\Steps\CreateUserStep
    
  - type: action
    class: App\Flowpipe\Steps\SendWelcomeEmailStep

3. Execute Your Flow

use Grazulex\LaravelFlowpipe\Flowpipe;

$result = Flowpipe::fromYaml('user-registration')->execute();

📚 Documentation

Getting Started

• Installation & Setup - Get up and running in minutes
• Your First Flow - Create and execute your first YAML workflow
• Understanding YAML Flows - Master the YAML syntax

Core Concepts

• YAML Flow Structure - Complete YAML reference
• PHP Steps - Creating and using PHP step classes
• Step Groups - Organize and reuse workflow components
• Conditions & Branching - Dynamic workflow execution

Advanced Features

• Error Handling - Retry, fallback, and compensation strategies
• Queue Integration - Asynchronous workflow processing

Tools & Configuration

• Artisan Commands - Powerful CLI tools for workflow management
• Configuration - Complete configuration reference

Examples

• User Registration Flow - Complete real-world example

🎯 Example: Simple User Registration

Here's what a complete user registration workflow looks like:

# flows/user-registration.yaml
flow: user-registration
description: Complete user registration with validation and email verification

send:
  name: "John Doe"
  email: "[email protected]"
  password: "SecurePassword123!"
  terms_accepted: true

steps:
  - type: group
    name: user-validation
    
  - type: action
    class: App\Flowpipe\Steps\CreateUserStep
    
  - type: action
    class: App\Flowpipe\Steps\SendVerificationEmailStep
    
  - type: action
    class: App\Flowpipe\Steps\SendWelcomeEmailStep

Execute it with:

$result = Flowpipe::fromYaml('user-registration')
    ->send(['name' => 'Jane', 'email' => '[email protected]'])
    ->execute();

🔗 Quick Links

• GitHub Repository
• Installation Guide
• First Flow Tutorial

---

Laravel Flowpipe is built for developers who want to create maintainable, scalable workflows without sacrificing code quality or Laravel conventions.