README.md

Laravel Workflow Sample App

This is a sample Laravel 12 application with example workflows that you can run inside a GitHub codespace.

Step 1

Create a codespace from the main branch of this repo.

Step 2

Once the codespace has been created, wait for the codespace to build. This should take between 5 to 10 minutes.

Step 3

Once it is done. You will see the editor and the terminal at the bottom.

Step 4

Run composer install.

composer install

Step 5

Run the init command to setup the app, install extra dependencies and run the migrations.

php artisan app:init

Step 6

Start the queue worker. This will enable the processing of workflows and activities.

php artisan queue:work

Step 7

Create a new terminal window.

Step 8

Start the example workflow inside the new terminal window.

php artisan app:workflow

Step 9

You can view the waterline dashboard at https://[your-codespace-name]-80.preview.app.github.dev/waterline/dashboard.

Step 10

Run the workflow and activity tests.

php artisan test

That's it! You can now create and test workflows.

---

More Workflows to Explore

In addition to the basic example workflow, you can try these other workflows included in this sample app:

• php artisan app:elapsed – Demonstrates how to correctly track start and end times to measure execution duration.

• php artisan app:microservice – A fully working example of a workflow that spans multiple Laravel applications using a shared database and queue.

• php artisan app:playwright – Runs a Playwright automation, captures a WebM video, encodes it to MP4 using FFmpeg, and then cleans up the WebM file.

• php artisan app:webhook – Showcases how to use the built-in webhook system for triggering workflows externally.

Try them out to see Laravel Workflow in action across different use cases!