Tutorials

Description

Tutorials manages in-app guidance content for Laravel Enso.

The package stores tutorial records, exposes create/edit/table/export endpoints, serves a runtime load endpoint for frontend consumers, and classifies tutorials by placement through an enum.

Installation

Install the package:

composer require laravel-enso/tutorials

Run the migrations:

php artisan migrate

Features

CRUD backend with form and table builders.
Runtime loader endpoint for frontend tutorial rendering.
Placement enum for deciding where tutorials are shown.
JSON resources for edit/show payloads.

Usage

Routes are registered under:

prefix: api/system/tutorials
name prefix: system.tutorials.
middleware: api, auth, core

Endpoints:

GET create
POST /
GET {tutorial}/edit
PATCH {tutorial}
DELETE {tutorial}
GET initTable
GET tableData
GET exportExcel
GET load

Key model:

LaravelEnso\Tutorials\Models\Tutorial

Enum:

LaravelEnso\Tutorials\Enums\Placement

API

This package exposes its backend integration through the routes, controllers, services, jobs, and configuration points referenced in the usage examples above.

Consumers should rely on the published config keys, documented route groups, and explicit service classes shown in the examples. Internal helper classes, listeners, casts, and background jobs are implementation details unless the README calls them out as extension points.

Depends On

Required Enso packages:

Companion frontend package:

@enso-ui/tutorials ↗

Contributions

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

Thank you to all the people who already contributed to Enso!