escolalms/api

Headless LMS

0.5.16 2024-11-20 09:52 UTC

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/tracker: ^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

MIT

• Mateusz Wojczal
• Paweł Chołaj
• Hubert Krzysztofiak
• Maciej Rymarz
• Tomasz Smolarek
• Witold Wiśniewski

• laravel
• lms
• reactjs
• learning-management-system

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

1. Clone this repo
2. 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

License