Weave Code
Onboarding Laravel Package
guava/onboarding
Guava Onboarding provides a Laravel-friendly foundation for building user onboarding flows, with structured steps and a simple API to guide new users through setup. Add configurable onboarding journeys to your app without building the plumbing from scratch.
This is my package onboarding
Frequently asked questions about Onboarding
- How do I install guava/onboarding in a Laravel app?
- Install it with Composer using composer require guava/onboarding, then publish the package config and migrations and register the Filament plugin in your panel provider. The package follows the standard Laravel package shape with service provider registration and publishable assets. Confirm the declared Laravel, PHP, and Filament constraints in composer.json before installing in production.
- Does guava/onboarding require Filament?
- The package's main value is its Filament integration for managing onboarding flows, so it is a strong fit when Filament is already your admin layer. The core onboarding models may be usable headless, but that mode is not confirmed in the available documentation. Validate whether the admin panel is mandatory before adopting it for a non-Filament stack.
- Which Laravel and PHP versions does guava/onboarding support?
- The overview does not publish a definitive support matrix, so check the package composer.json for its Laravel, PHP, and Filament constraints. The technical assessment targets Laravel 10, 11, or 12 with PHP 8.2+ and Filament, but that is an evaluation context rather than a confirmed declaration. Pin a version that resolves cleanly against your application's framework and Filament majors.
- Does guava/onboarding support Filament v5, v4, and v3?
- Release 2.2.1 contains a fix specifically for Filament v5 compatibility, which suggests 2.2.0 had a breakage on that major. Check the composer constraint to see whether the package supports Filament v3, v4, and v5 simultaneously or forces a specific major. If you are pinned to an older Filament major, verify dependency resolution before upgrading.
- How do I define onboarding steps and track user progress with guava/onboarding?
- The package provides a structured onboarding domain with steps and progress or state tracking, exposed through a simple API. The README excerpt provided here does not show the exact model and API names, so review the published config, migrations, and source after installation. Model your onboarding journeys as data rather than hard-coding them so the package's step definitions can drive the flow.
- Is onboarding progress modeled as a state machine or as boolean flags?
- The available material does not confirm whether onboarding progress is an explicit state machine with idempotent transitions or ad-hoc boolean or JSON flags. Inspect the published migrations and model methods before relying on transition safety. If the package lacks idempotent transitions, wrap progress updates in your own service layer or database constraints.
- How do I upgrade guava/onboarding from 2.2.0 to 2.2.1?
- Upgrading from 2.2.0 to 2.2.1 is a drop-in patch with no API, deprecation, or config changes noted. If you are on 2.2.0 and broken against Filament v5, upgrade immediately because this release is the fix. If you are on an older 2.x with Filament v3 or v4, check the composer constraint before bumping because a compatibility patch can change the resolved dependency graph.
- Is guava/onboarding production-ready and actively maintained?
- The package is actively released with conventional commits and semantic versioning, but it comes from a small vendor namespace with single-maintainer exposure. Pin to a minor such as ^2.2, allow patch releases, and gate minor upgrades behind a staging run. Review CI coverage across supported Laravel and Filament versions before treating it as production-critical.
- What are the migration and schema risks with guava/onboarding?
- Published migrations become part of your application, so review their contents before running them in production. Determine whether they are additive-only or alter existing tables, and design a rollback and backfill strategy for stateful onboarding progress data. Because onboarding tables are user-facing and stateful, treat schema ownership as an application concern rather than a package concern.
- Should I use guava/onboarding or build my own Laravel onboarding flow?
- Use guava/onboarding when you want a Laravel-native onboarding domain plus a Filament admin UI without building the plumbing yourself. Build your own flow if you are not on Filament, need a fully headless API, or require a state machine with guarantees the package does not document. A short spike that installs the package, publishes migrations, and models one journey will show whether it fits.
Weaver
How can I help you explore Laravel packages today?