{"repo":"spatie/laravel-onboard","free":true,"listed":false,"github":"https://github.com/spatie/laravel-onboard","clone":"git clone https://github.com/spatie/laravel-onboard.git","description":"A Laravel package to help track user onboarding steps","language":"PHP","stars":844,"topics":["laravel","onboarding","php","saas"],"license":"MIT","category":"saas-starters-boilerplates","readme_excerpt":"A Laravel package to help track user onboarding steps This package lets you set up an onboarding flow for your application's users. Here's an example of how it's set up: You can then render this onboarding flow however you want in your templates: Support us We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products. We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall. Installation You can install the package via composer: Usage Add the Spatie\\Onboard\\Concerns\\GetsOnboarded trait and Spatie\\Onboard\\Concerns\\Onboardable interface to any model or class in your app, for example the User model: Example configuration Configure your steps in your App\\Providers\\AppServiceProvider.php The variable name passed to the completeIf callback must be $model . Usage Now you can access these steps along with their state wherever you like. Here is an example blade template: Check out all the available features below: Excluding steps based on condition: Limiting steps to a specific class: When using limited steps, steps that are not limited will be available to all classes. For example: The above will result in 1 step being available to all classes, and 2 steps being available to the User and Team classes: Other classes will only see the Normal Step . U","default_branch":null,"files":null,"tree":[],"storefront":"/r/spatie","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/spatie/laravel-onboard/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}