Define and track multiple onboarding flows for your Laravel application.
roundly-consulting/onboarding-for-laravel is a Laravel package for define and track multiple onboarding flows for your laravel application..
It currently has 5 GitHub stars and 38 downloads on Packagist (latest version 2.0.0).
Install it with composer require roundly-consulting/onboarding-for-laravel.
Discover more Laravel packages by roundly-consulting
or browse all Laravel packages to compare alternatives.
Last updated
Describe onboarding as flows of ordered steps and derive each user's progress on the fly from the data you already have — no tables, nothing to persist. Ask a model for its flow to get the next step, the completion percentage and a JSON-ready array for your frontend, and keep unfinished users on their current step with one middleware.
Requires PHP 8.4 and Laravel 13.
composer require roundly-consulting/onboarding-for-laravel
Register a flow once, in a service provider's boot():
use App\Models\User;
use RoundlyConsulting\Onboarding\Facades\Onboarding;
use RoundlyConsulting\Onboarding\Flow;
use RoundlyConsulting\Onboarding\Step;
Onboarding::register(Flow::make('Profile Onboarding')->of([
Step::make('Verify email')->route('verification.notice')->completeWhenFilled('email_verified_at'),
Step::make('Upload photo')->cta('Upload now')->route('profile.photo')->completeWhenFilled('avatar_path'),
Step::make('Add a bio')->optional()->completeIf(fn (?User $user) => filled($user?->bio)),
]));
Add GetsOnboarded to the model and read its progress:
use RoundlyConsulting\Onboarding\Traits\GetsOnboarded;
class User extends Authenticatable
{
use GetsOnboarded;
}
$user->onboardingProgress(); // 33.33
$user->nextOnboardingStep()?->title; // "Upload photo"
Onboarding::for($user)?->toArray(); // title, percentage, next step, every step
Send users who haven't finished to their current step:
Route::middleware(['auth', 'onboarding'])->group(function () {
Route::get('/dashboard', DashboardController::class);
});
The full documentation — configuration, every feature and its API, and testing — lives on our website: roundly-consulting.com/open-source/docs/onboarding-for-laravel
Release notes are in CHANGELOG.md. To contribute, see the contributing guide.
This package is free and open source, built and maintained by Roundly Consulting. If it saves you time, please consider supporting our open-source work — a one-time donation, a monthly pledge on Patreon or a crypto donation helps fund maintenance, new features and new packages.
The MIT License (MIT). Please see License File for more information.
Get paid by clients abroad
Wise gives you local bank details in several currencies and converts at the mid-market rate. Useful when your invoices are not in your own currency.
Try WiseNew Laravel packages worth a look, once a month. No spam, one-click unsubscribe.