api (Laravel application)

Laravel Headless LMS REST API.

Documentation

Most of the documentation is hosted at docs.ulams.app.

Configuration

Please not that API is based on Laravel but it’s configured by environmental variables Please don’t create or edit any .env file but use environmental variables with LARAVEL_ prefix, see docker-compose.yml for reference.

As we want this package to be stateless and easy to scale all configuration is stored either in database or in environmental variables.

See [docs][docs] for more details.

Application is designed to be stateless - it is controlled by environmental variables

Installation from source code

If you want to use the software consider using our docker images or using Create-LMS-App/ helper.

You should consider install with our installation package.

To install default docker environment either clone this repo or use

See [docs/multidomain.md][docs/multidomain.md] for more details how to quick start.

Quick start

1. Clone this repo
2. docker compose up -d

Stack

Part	Version
PHP	8.4 (image built from docker/php on php:8.4-fpm-alpine)
Laravel	13.x, non-slim skeleton (app/Http/Kernel.php, config/app.php provider list)
Multitenancy	gecche/laravel-multidomain 13 (one .env.<host> per tenant)
Auth	Laravel Passport 13: personal access tokens (RS256), UUID client ids
Tests	PHPUnit 12, Orchestra Testbench 11 (package suites), PostgreSQL
Uploads	image rules use image:allow_svg (Laravel 12+ rejects SVG otherwise)
API docs	darkaonline/l5-swagger 11 / zircote/swagger-php 6 reading @OA\ docblocks

Useful commands (in the api container):

php artisan about                          # versions and drivers
php artisan migrate --force                # platform database
php artisan ulams:tenant:sync-env --migrate  # every tenant database
php artisan passport:keys --force          # writes 600/660; Passport 13 rejects world-readable key files
php artisan passport:client --personal --provider=users --no-interaction
php artisan l5-swagger:generate
./vendor/bin/phpunit --testsuite courses   # one package suite

Demo

https://api-stage.ulams.app/api/documentation

This is fully working demo. Note that content is regenerated every day - it’s a seeder that is not persistent, every day database and files are cleared and rebuilt from skratch.

Packages

This API consists of Laravel and multiple packages.

List of all packages is available at packagist.org/?query=escolalms.

Tests

Just run phpunit to test all the packages.

Summary code coverage from all the packages:

Test

There are hundreds of tests in the packages and they are divided into:

Integration packages test

Each packge contains their own php integration test this repo runs all of the

To run use ./vendor/bin/phpunit

Tasks

See makefile for all available devops tasks

License