escolalms / api
Headless LMS
Installs: 91
Dependents: 0
Suggesters: 0
Security: 0
Stars: 12
Watchers: 2
Forks: 8
Open Issues: 0
Type:project
Requires
- php: >=8.1
- darkaonline/l5-swagger: ^8
- doctrine/dbal: ^2|^3
- escolalms/assign-without-account: ^0
- escolalms/auth: ^0
- escolalms/bookmarks_notes: ^0
- escolalms/bulk-notifications: ^0
- escolalms/cart: ^0
- escolalms/categories: ^0
- escolalms/cmi5: ^0
- escolalms/consultation-access: ^0
- escolalms/consultations: ^0
- escolalms/core: ^1
- escolalms/course-access: ^0
- escolalms/courses: ^0
- escolalms/courses-import-export: ^0.1.21
- escolalms/csv-users: ^0
- escolalms/dictionaries: ^0
- escolalms/files: ^0
- escolalms/headless-h5p: ^0
- escolalms/images: ^0
- escolalms/invoices: ^0
- escolalms/lrs: ^0
- escolalms/mailerlite: ^0
- escolalms/mattermost: ^0
- escolalms/model-fields: ^0
- escolalms/notifications: ^0
- escolalms/pages: ^0
- escolalms/payments: ^0
- escolalms/permissions: ^0
- escolalms/questionnaire: ^0
- escolalms/recommender: ^0
- escolalms/reports: ^0
- escolalms/scorm: ^0
- escolalms/settings: ^0
- escolalms/stationary-events: ^0
- escolalms/tags: ^0
- escolalms/tasks: ^0
- escolalms/templates: ^0
- escolalms/templates-email: ^0
- escolalms/templates-pdf: ^0
- escolalms/templates-sms: ^0
- escolalms/topic-type-gift: ^0
- escolalms/topic-type-project: ^0
- escolalms/topic-types: ^0
- escolalms/translations: ^0
- escolalms/video: ^0
- escolalms/vouchers: ^0
- escolalms/webinar: ^0
- gecche/laravel-multidomain: ^5.0
- guzzlehttp/guzzle: ^7.4.5
- laravel/framework: ^9
- laravel/helpers: ^1.7
- laravel/horizon: ^5
- laravel/passport: ^11
- laravel/socialite: ^5.1
- laravel/tinker: ^2.9
- league/flysystem-aws-s3-v3: ^3.0
- predis/predis: ^2.2
- psr/http-message: ^1
- sentry/sentry-laravel: ^4.2
- spatie/laravel-health: ^1.30
- spatie/laravel-permission: ^6.3
- staudenmeir/laravel-migration-views: ^1.0
Requires (Dev)
- fakerphp/faker: ^1.9.1
- filp/whoops: ^2.0
- mockery/mockery: ^1.0
- nunomaduro/collision: ^7
- orchestra/testbench: ^7
- php-mock/php-mock-phpunit: ^2.6
- phpunit/phpunit: ^9.0
- spatie/laravel-ignition: ^1.0
- dev-develop
- 1.0.11
- 1.0.10
- 1.0.9
- 1.0.8
- 1.0.7
- 1.0.6
- 1.0.5
- 1.0.4
- 1.0.3
- 1.0.2
- 1.0.1
- 1.0.0
- 0.5.33
- 0.5.32
- 0.5.31
- 0.5.30
- 0.5.29
- 0.5.28
- 0.5.27
- 0.5.26
- 0.5.25
- 0.5.24
- 0.5.23
- 0.5.22
- 0.5.21
- 0.5.20
- 0.5.19
- 0.5.18
- 0.5.17
- 0.5.16
- 0.5.15
- 0.5.14
- 0.5.13
- 0.5.12
- 0.5.11
- 0.5.10
- 0.5.9
- 0.5.8
- 0.5.7
- 0.5.6
- 0.5.5
- 0.5.4
- 0.5.3
- 0.5.2
- 0.5.1
- 0.5.0
- 0.4.8
- 0.4.7
- 0.4.6
- 0.4.5
- 0.4.4
- 0.4.3
- 0.4.2
- 0.4.1
- 0.4.0
- 0.3.105
- 0.3.104
- 0.3.103
- 0.3.102
- 0.3.101
- 0.3.100
- 0.3.99
- 0.3.98
- 0.3.97
- 0.3.96
- 0.3.95
- 0.3.94
- 0.3.93
- 0.3.92
- 0.3.91
- 0.3.90
- 0.3.89
- 0.3.88
- 0.3.87
- 0.3.86
- 0.3.85
- 0.3.84
- 0.3.83
- 0.3.82
- 0.3.81
- 0.3.80
- 0.3.79
- 0.3.78
- 0.3.77
- 0.3.76
- 0.3.75
- 0.3.74
- 0.3.73
- 0.3.72
- 0.3.71
- 0.3.70
- 0.3.69
- 0.3.68
- 0.3.67
- 0.3.66
- 0.3.65
- 0.3.64
- 0.3.63
- 0.3.62
- 0.3.61
- 0.3.60
- 0.3.59
- 0.3.58
- 0.3.57
- 0.3.56
- 0.3.55
- 0.3.54
- 0.3.53
- 0.3.52
- 0.3.51
- 0.3.50
- 0.3.49
- 0.3.48
- 0.3.47
- 0.3.46
- 0.3.45
- 0.3.44
- 0.3.43
- 0.3.42
- 0.3.41
- 0.3.40
- 0.3.39
- 0.3.38
- 0.3.37
- 0.3.36
- 0.3.35
- 0.3.34
- 0.3.33
- 0.3.32
- 0.3.31
- 0.3.30
- 0.3.27
- 0.3.26
- 0.3.25
- 0.3.24
- 0.3.23
- 0.3.22
- 0.3.21
- 0.3.20
- 0.3.19
- 0.3.18
- 0.3.17
- 0.3.16
- 0.3.15
- 0.3.14
- 0.3.13
- 0.3.12
- 0.3.11
- 0.3.10
- 0.3.9
- 0.3.8
- 0.3.7
- 0.3.6
- 0.3.5
- 0.3.4
- 0.3.3
- 0.3.2
- 0.3.1
- 0.3.0
- 0.2.99
- 0.2.98
- 0.2.97
- 0.2.96
- 0.2.95
- 0.2.94
- 0.2.93
- 0.2.92
- 0.2.91
- 0.2.9
- 0.2.8
- 0.2.7
- 0.2.6
- 0.2.5
- 0.2.4
- 0.2.3
- 0.2.2
- 0.2.1
- 0.1.14
- 0.1.13
- 0.1.12
- 0.1.11
- 0.1.10
- 0.1.9
- 0.1.8
- 0.1.7
- 0.1.6
- 0.1.5
- 0.1.4
- 0.1.3
- 0.1.2
- 0.1.1
- 0.1.0
- v0.0.1
- dev-main
- dev-feature/php83-bookworm
- dev-feature/scorms_s3
- dev-feature/l9
This package is auto-updated.
Last update: 2025-05-16 10:11:20 UTC
README
Laravel Headless LMS REST API.
Documentation
Most of the documentation is hosted at docs.wellms.io.
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
- Clone this repo
docker compose up -d
Demo
https://api-stage.escolalms.com/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