Installation
Require the package with Composer. The service provider and the Onboarding facade alias are registered automatically through package discovery:
composer require roundly-consulting/onboarding-for-laravelThere is nothing to publish: no config file, no migrations, no views and no translations of its own. The package is entirely in-memory and stateless, so vendor:publish has nothing to offer and php artisan migrate has nothing of ours to run.
What the provider registers
- The OnboardingManager as a container singleton — every facade call and every injected OnboardingManager share the same flows, resolver and store.
- The onboarding:list Artisan command.
- The onboarding route middleware alias (RequireOnboarding).
- An onboarding section in php artisan about.
Check the wiring
php artisan about --only=onboardingOnboarding ..............................................................
Flows .................................................... 2 registered
Steps ...................................................... 7 declared
Default flow ............................................... REGISTERED
Persistence store .................................... NONE (stateless)
Middleware alias ............................................ onboardingThe section reports the shape of your onboarding — how many flows and steps are registered, whether a default flow and a persistence store are bound — and never your flow keys, step copy or redirect targets. It only checks whether a store is bound; it never resolves it.
Where to register flows
Because the manager is a singleton, register your flows in the boot() method of one of your application’s service providers — they then exist for every request. See Registering flows.
Show your open-source love
This package is free and MIT-licensed. If it saves you time, a one-off donation or a Patreon membership keeps it maintained, tested and documented.
More ways to support, including cryptoBy donating, you agree to our donation terms.
Want this built into your product?
We integrate our packages into custom Laravel and AI builds. Tell us what you're working on and we'll reply within 48 hours.