Installation Setup

🚀 Installation & Setup

← Home | Your First Flow →

Get Laravel Flowpipe up and running in your Laravel application in just a few steps.

📋 Requirements

• PHP 8.1 or higher
• Laravel 9.0 or higher
• Composer

📦 Installation

1. Install via Composer

composer require grazulex/laravel-flowpipe

2. Publish Configuration (Optional)

php artisan vendor:publish --provider="Grazulex\LaravelFlowpipe\LaravelFlowpipeServiceProvider"

This creates config/flowpipe.php with the following default settings:

<?php

return [
    /*
    |--------------------------------------------------------------------------
    | Flow Definitions Path
    |--------------------------------------------------------------------------
    |
    | Directory where your YAML flow definitions are stored.
    | Relative to your Laravel application root.
    |
    */
    'definitions_path' => 'flows',

    /*
    |--------------------------------------------------------------------------
    | Default Step Namespace
    |--------------------------------------------------------------------------
    |
    | Default namespace for step classes when using simple class names
    | in YAML files.
    |
    */
    'step_namespace' => 'App\\Flowpipe\\Steps',

    /*
    |--------------------------------------------------------------------------
    | Group Definitions Path
    |--------------------------------------------------------------------------
    |
    | Directory where your YAML group definitions are stored.
    |
    */
    'groups_path' => 'groups',

    /*
    |--------------------------------------------------------------------------
    | Tracing Configuration
    |--------------------------------------------------------------------------
    |
    | Configure execution tracing and debugging features.
    |
    */
    'tracing' => [
        'enabled' => env('FLOWPIPE_TRACING_ENABLED', true),
        'tracer' => 'default',
    ],

    /*
    |--------------------------------------------------------------------------
    | Queue Configuration
    |--------------------------------------------------------------------------
    |
    | Configure queue integration for asynchronous flow execution.
    |
    */
    'queue' => [
        'connection' => env('FLOWPIPE_QUEUE_CONNECTION', 'default'),
        'queue' => env('FLOWPIPE_QUEUE_NAME', 'flowpipe'),
    ],
];

📁 Directory Structure

After installation, create the recommended directory structure:

your-laravel-app/
├── flows/                          # YAML flow definitions
│   ├── user-registration.yaml
│   ├── order-processing.yaml
│   └── content-moderation.yaml
├── groups/                         # Reusable step groups
│   ├── user-validation.yaml
│   ├── payment-processing.yaml
│   └── notifications.yaml
└── app/
    └── Flowpipe/
        ├── Steps/                  # PHP step classes
        │   ├── ValidateInputStep.php
        │   ├── CreateUserStep.php
        │   └── SendEmailStep.php
        └── Conditions/             # Custom conditions
            └── EmailEnabledCondition.php

🔧 Environment Configuration

Add these optional environment variables to your .env file:

# Enable/disable tracing (default: true)
FLOWPIPE_TRACING_ENABLED=true

# Queue connection for async flows
FLOWPIPE_QUEUE_CONNECTION=redis
FLOWPIPE_QUEUE_NAME=workflows

✅ Verification

Test your installation by running:

php artisan flowpipe:list

You should see the Laravel Flowpipe commands available.

🎯 What's Next?

1. Create Your First Flow - Build a simple workflow
2. Understanding YAML Flows - Learn the YAML syntax
3. PHP Steps - Create custom step classes

🆘 Troubleshooting

Common Issues

"Class not found" errors

• Ensure your step classes are properly namespaced
• Check the step_namespace configuration
• Run composer dump-autoload

YAML files not found

• Verify the definitions_path configuration
• Ensure YAML files are in the correct directory
• Check file permissions

Need Help?

• Configuration Reference
• GitHub Issues