Download the PHP package escolalms/headless-h5p without Composer
On this page you can find all versions of the php package escolalms/headless-h5p. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package headless-h5p
Headless H5P Laravel API for Escola LMS ecosystem
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
composer require escolalms/headless-h5p
php artisan migrate
php artisan h5p:storage-link
see belowphp 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
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.
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
You can seed library and content with build-in seeders as command that are accessible with
php artisan h5p:seed
to add just librariesphp 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
All versions of headless-h5p with dependencies
laravel/framework Version >=9.0
h5p/h5p-core Version 1.24.*|dev-master
h5p/h5p-editor Version 1.24.*|dev-master
escolalms/core Version ^1
escolalms/auth Version ^0
escolalms/settings Version ^0