Skip to main content

Installation

Requirements​

Before installing Laravel Flow, make sure you have:

  • PHP >= 8.1
  • Laravel >= 10.0
  • Composer

Install via Composer​

Run the following command to pull in the latest version:

composer require jobmetric/laravel-flow

Publish Configuration​

After installation, publish the configuration file:

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

Publish Migrations​

Publish the migration files to create the necessary database tables:

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

Then run the migrations:

php artisan migrate

Next Steps​

After installation, you can:

  • Check out the Showcase to see real-world examples
  • Learn about HasFlow and HasWorkflow traits to integrate workflows into your models
  • Explore the Services for managing flows, states, tasks, and transitions
  • Read the Getting Started guide for an overview