README

A monitoring dashboard for the Saucy event sourcing framework's projections. Provides a React-based UI to view projection status, activity logs, and manage projections (pause, resume, replay, trigger).

Installation

Install the package via composer:

composer require saucy/dashboard

Publish the frontend assets:

php artisan vendor:publish --tag="saucy-dashboard-assets"

Important: Re-run this command after updating the package to get the latest frontend build.

Optionally, publish the config file:

php artisan vendor:publish --tag="saucy-dashboard-config"

Configuration

The published config file (config/saucy-dashboard.php):

return [
    'password' => env('SAUCY_DASHBOARD_PASSWORD', null),
];

Password Protection

By default the dashboard is open to anyone. To require a password, add to your .env:

SAUCY_DASHBOARD_PASSWORD=your-secret-password

When set, visitors must enter the password on a login screen. The authenticated session is managed via Laravel's session driver.

Usage

Once installed, navigate to:

https://your-app.com/saucy-dashboard

The dashboard provides:

• Dashboard — main overview page
• Projections — lists all registered projections with their position and status (running, paused, standby), auto-refreshes every 2 seconds
• Projection detail — click a projection to see its activity log (refreshes every second) and action buttons:
  • Pause / Resume — pause or resume the projection
  • Replay — trigger a full replay from the beginning
  • Trigger — manually start the process

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Robertbaelde
• All Contributors

License

The MIT License (MIT). Please see License File for more information.