This package is not installable via Composer 1.x, please make sure you upgrade to Composer 2+. Read more about our Composer 1.x deprecation policy.

Headless LMS

v0.0.1 2021-05-05 15:13 UTC

This package is auto-updated.

Last update: 2021-09-23 10:55:49 UTC


README

Laravel Headless LMS REST API.

swagger API phpunit phpunit downloads downloads downloads

Packages

Installation

To install defult docker enviroment 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 admin@escola-lms.com secret
Tutor tutor@escola-lms.com secret
Student student@escola-lms.com secret

Demo

https://escola-lms-api.stage.etd24.pl/api/documentation

This is fully working demo. Note that content is regeneraed 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 availabe devops tasks

  • make test-phpunit
  • make test-behat
  • 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-behat-postgres
  • make test-phpunit-mysql
  • make test-behat-mysql
  • make init
  • make init-mysql
  • make init-postgres