escolalms/api

Headless LMS

0.4.5 2024-03-28 11:00 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-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.

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:

Installation

You should consider install with our installation package.

To install default docker environment either clone this repo or use

composer create-project escolallms/api escola-lms

Postgres (default)

make init

Mysql

make init-mysql

Demo & Credentials

Role	Email ID	Password
Admin	[e-mail]	secret
Tutor	[e-mail]	secret
Student	[e-mail]	secret

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.

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

End-to-end tests

Cypress.io is running end-to-end tests

To launch those use yarn && yarn run cypress open

You can see the results in the cypress dashboard including video artifacts

Tasks

See makefile for all available devops tasks

• make test-phpunit
• make bash
• make composer-update
• make swagger-generate
• make migrate-fresh
• make switch-to-postgres
• make switch-to-mysql
• make migrate-mysql
• make migrate-postgres
• make test-phpunit-postgres
• make test-phpunit-mysql
• make init
• make init-mysql
• make init-postgres

License