pongraczi / TutorialManager

Laravel Enso user interface tutorial manager, meant to provide an interactive walk-through of the app's pages and its features

Tutorial Manager

Tutorial management dependency for Laravel Enso.

^{click on the photo to view a short demo in compatible browsers}

Features

• allows for a user friendly way of teaching users how to use the interface of the application
• permits adding, updating and deleting tutorial entries that can then be played for the selected route
• the tutorial functionality may be started/restarted from the right-hand sidebar, using the ? button

Under the Hood

• the tutorials table is used for the tutorial module and has several key attributes:
  • permission_id - the permission where they're in use, since permissions are tied to routes, and we're using permissions to know which tutorials to load for a page
  • element - identifies the element within the DOM, and may be an element, an id, in which case it should be prefixed with a # or a class, in which case it should be prefixed with . or a combination of these
  • placement - sets the position of the tutorial dialog, relative to the DOM element, and can be: top, bottom, left or right
  • order - gives the order in which a particular tutorial element should be displayed, in the context of the available tutorials for a certain page
• tutorial entries are displayed using Intro.js

Publishes

• php artisan vendor:publish --tag=tutorials-assets - the VueJS pages and components
• php artisan vendor:publish --tag=enso-assets - a common alias for when wanting to update the VueJS assets, once a newer version is released, can be used with the --force flag

Notes

The Laravel Enso Core package comes with this package included.

Depends on:

• Datatable for displaying the list of tutorial entries
• FormBuilder for creating the forms when managing tutorials
• Helpers for utility classes and traits
• PermissionManager for using permissions and routes to determine what tutorials to load
• StructureManager for the migrations

Contributions

are welcome. Pull requests are great, but issues are good too.

License

This package is released under the MIT license.