Headless LMS

0.4.7 2024-07-04 12:32 UTC

README

Laravel Headless LMS REST API.

swagger phpunit downloads downloads downloads Maintainability FOSSA Status

Packages

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

Packages

Tests

Just run phpunit to test all the packages.

Summary code coverage from all the packages:

cc Tests Code Coverage cc cc

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

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

FOSSA Status