README

An elegant UI for monitoring workflows.

Installation

This UI is installable via Composer.

composer require laravel-workflow/waterline

php artisan waterline:install

Authorization

Waterline exposes a dashboard at the /waterline URL. By default, you will only be able to access this dashboard in the local environment. However, within your app/Providers/WaterlineServiceProvider.php file, there is an authorization gate definition. This authorization gate controls access to Waterline in non-local environments.

Gate::define('viewWaterline', function ($user) {
    return in_array($user->email, [
        'admin@example.com',
    ]);
});

This will allow only the single admin user to access the Waterline UI.

Configuration

If your workflow IDs are strings (for example UUIDs) and do not sort in a useful order, publish the config and set workflow_sort_column to a timestamp column such as created_at:

'workflow_sort_column' => 'created_at',

Upgrading Waterline

After upgrading Waterline you must publish the latest assets.

composer require durable-workflow/waterline

php artisan waterline:publish

Dashboard View

Workflow View

Development

1. Install dependencies:

   composer install
   npm install

2. Build assets:

   npm run production

3. Publish assets to testbench:

   ./vendor/bin/testbench waterline:publish

4. Run migrations:

   ./vendor/bin/testbench workbench:create-sqlite-db
   ./vendor/bin/testbench migrate:fresh --database=sqlite

5. Start server:

   composer run serve

6. Access dashboard:
   • Local: http://localhost:18280/waterline
7. Create test workflow:

   ./vendor/bin/testbench workflow:create-test

8. Run queue worker:

   ./vendor/bin/testbench queue:work

_{^{"Laravel" is a registered trademark of Taylor Otwell. This project is not affiliated, associated, endorsed, or sponsored by Taylor Otwell, nor has it been reviewed, tested, or certified by Taylor Otwell. The use of the trademark "Laravel" is for informational and descriptive purposes only. Waterline is not officially related to the Laravel trademark or Taylor Otwell.}}