Installation and setup.

Laravel Checklist installs through Composer and Laravel package discovery. The common setup publishes its migrations and keeps the default table names.

1. Install the package

composer require byrcsc/laravel-checklist

Laravel discovers ByRcsc\LaravelChecklist\ChecklistServiceProvider through the package's Composer metadata.

2. Publish and run the migrations

php artisan vendor:publish --tag="checklist-migrations"
php artisan migrate

The publish tag writes seven migrations in dependency order. They create ten tables and add scoring, schedule, notification stamp, and action-head columns to the checklist table.

Publish the configuration first when you need different table names:

php artisan vendor:publish --tag="checklist-config"
php artisan vendor:publish --tag="checklist-migrations"
php artisan migrate

The migrations and models read the same checklist.table_names map. Changing a name after migration requires an application migration to rename the table.

3. Configure evidence storage

Evidence uses the local filesystem disk by default. Point it at a private disk in production:

CHECKLIST_EVIDENCE_DISK=s3

The package writes files below checklists/{checklist}/responses/{response}/. It records the disk and path, but it does not expose download routes. Build authorized or temporary URLs in your application.

4. Prepare database notifications

Shipped notifications use the mail and database channels. Create Laravel's notifications table if your application does not already have one:

php artisan make:notifications-table
php artisan migrate

Set CHECKLIST_NOTIFICATIONS=false when your application will listen to domain events and send its own notifications. Disabling shipped notifications does not disable events or audit history.

5. Schedule recurring work

Add the generator to routes/console.php when your application uses schedules, due-soon notifications, or overdue notifications:

use Illuminate\Support\Facades\Schedule;

Schedule::command('checklist:generate-due')->everyFifteenMinutes();

The command is safe to run more often. Database claims prevent concurrent runs from generating the same occurrence or announcing the same transition twice.

6. Publish notification wording when needed

php artisan vendor:publish --tag="checklist-translations"

This publishes the English notification lines. Publishing them is optional; the package loads its own copy otherwise.

What to read next

• Quick start to publish and complete a first checklist.
• Configuration for every key and default.
• Create a schedule to materialize recurring work.