escolalms/headless-h5p

Headless H5P Laravel REST API

0.5.6 2024-11-15 08:47 UTC

Requires

• php: >=7.4
• escolalms/auth: ^0
• escolalms/core: ^1
• escolalms/settings: ^0
• h5p/h5p-core: 1.24.*|dev-master
• h5p/h5p-editor: 1.24.*|dev-master
• laravel/framework: >=9.0

Requires (Dev)

• guzzlehttp/guzzle: ^7
• laravel/legacy-factories: ^1.0.4
• nunomaduro/larastan: ^2.0
• orchestra/testbench: ^7.0
• phpunit/phpunit: ^9.0

MIT

• Mateusz Wojczal

README

Before you begin

This product is tightly coupled with the Escola LMS ecosystem and is not compatible with any other Laravel application.

Working demo

Proof of concept demo is available at https://h5p-laravel-demo.stage.etd24.pl/.

Features

All of the features are available thought REST API, there are no blade templates of using server side rendering H5PIntegration global js variable, this is a different approach then moodle, drupal and wordpress h5p plugins.

This package does provide only REST API access endpoints, this is so far only package that allows to render h5p headlessly.

The features includes:

• play all h5p content - exposed all essential data, yet player is needed
• edit all h5p content - exposed all essential data, yet editor is needed
• CRUD libraries
• CRUD content
• upload library from .h5p file
• upload content from .h5p file
• all the other h5p features like export etc

Documentation

See Swagger documented endpoints.

Some tests can also be a great point of start.

To play the content you can use EscolaLMS H5P Player

Demo React source files, are great starting point for frontend tutorial

Install

1. composer require escolalms/headless-h5p
2. php artisan migrate
3. php artisan h5p:storage-link see below
4. php artisan db:seed --class="EscolaLms\HeadlessH5P\Database\Seeders\PermissionTableSeeder" see below

Storage links

You need to publish many of files to be available as public link.

php artisan h5p:storage-link which creates a symbolic link from storage/app/h5 and vendor/h5p/h5p-core and vendor/h5p/h5p-editor to be accessible to public, as follows

public_path('h5p') => storage_path('app/h5p'),
public_path('h5p-core') => base_path().'vendor/h5p/h5p-core',
public_path('h5p-editor') => base_path().'vendor/h5p/h5p-editor',

Cors

All the endpoints need to be accessible from other domains, so CORS must be properly set.

Except of endpoints assets must expose CORS headers as well. You achieve that by setting Apache/Nginx/Caddy/Whatever settings - below is example for Nginx for wildcard global access.

location ~* \.(eot|ttf|woff|woff2|jpg|jpeg|gif|png|wav|mp3|mp4|mov|ogg|webv)$ {
    add_header Access-Control-Allow-Origin *;
}

Authorization

Most of the endpoints require authorization, this is possible with Laravel passport

There is a seeder to must be run in order to authorize

User model is taken from Auth package.

Seeder

To seed content and library

php artisan db:seed --class="\EscolaLms\HeadlessH5P\Database\Seeders\ContentLibrarySeeder"

You can seed library and content with build-in seeders as command that are accessible with

• php artisan h5p:seed to add just libraries
• php artisan h5p:seed --addContent to add content with libraries

Road map

• rewrite h5p core in a way like luminare in typescript

Running test locally

run ./test.sh