dansleboby / intro-step

Laravel intro step plugin with introjs

IntroStep

A package for make intro on laravel.

Purpose

Make intro on laravel with a panel.

Installing

Step 1

Install composer package to your project. with this command

composer require whtht/intro-step

Step 2

Vendor publishing with this code.

php artisan vendor:publish --force --provider=Whtht\IntroStep\IntroStepServiceProvider

Step 3

Go to config/intro-step.php and edit as

// web_middleware => /intro-step-admin page middlewares
// api_middleware => Api middlewares
// user_table => Your user table name
// user_column => Your user relationship column
// user_model => Your user model path

and

php artisan config:cache

Step 4

php artisan migrate

Step 5

Append providers array in config/app.php

\Whtht\IntroStep\IntroStepServiceProvider::class,

Step 6

Append aliases array in config/app.php

"IntroStep" => Whtht\IntroStep\Facade\IntroStep::class,

Step 7

Recache your configs with intro-step configs in your terminal

php artisan config:cache

and go to app/Http/Middlewares/VerifyCsrfToken.php and add this

protected $except = [
    //...
    "intro-step-admin/*"
];

Step 8

Append this @intro_step blade directive on your layout blade or any blade like this.

And clear view cache with `php artisan view:clear`

Step 9

Now you ready to go on your http://yourwebsite.com/intro-step-admin page

Now lets create a step

Example Edit Page about how this fields must be fill

Step 10

Change view render function on controller view() to IntroStep::viewWithIntro() like this

Step 11

Go to this step url (/home this example) and see this steps

License

This project is licensed under the MIT License.