brnysn/laravel-h5p

H5P integration for Laravel without any additional dependencies.

Maintainers

Details

github.com/brnysn/Laravel-H5P

Source

Issues

Installs: 228

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 0

Forks: 21

Open Issues: 1

Type:package

1.1.0 2023-09-26 14:45 UTC

Requires

Requires (Dev)

MIT c9af887156647963068ef795eca47d7be2c430a1

  • Yasin Baran <brnysn.woop@gmail.com>

This package is auto-updated.

Last update: 2024-04-26 16:07:04 UTC

README

Forked from https://github.com/EscolaLMS

Description

This package provides a Laravel API for interacting with H5P content without installing unrelated dependencies.

Main repository requires 8 unrelated packages - most of them are escolalms dependencies - to be installed:

  • EscolaLms/core
  • EscolaLms/auth
  • EscolaLms/settings
  • EscolaLms/files
  • EscolaLms/categories
  • EscolaLms/model-fields
  • spatie/permission
  • laravel/socialite

Original Documentation

Features

The lib allows headlessly

  • 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

See Swagger documented endpoints.

Some tests can also be a great point of start.

To play the content you can use EscolaLMS H5P Player

Install

  1. composer require brnysn/headless-h5p
  2. php artisan migrate
  3. php artisan h5p:storage-link see below

Storage links

You need to publish many of files to be availabe 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 accesible 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 accesible from other domains, so CORS must be properlly set.

Except of endpoints assets must expose CORS headers as well. You achive 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 *;
}

Authorisation

Most of the endpoints require authorisation, this is possible with laravel passport

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

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