77 lines
3.3 KiB
Markdown
77 lines
3.3 KiB
Markdown
|
# <img src="doc/images/logo/logo.png" width="40" height="40"> [TAO](https://www.taotesting.com/) - LTI 1.3 Core Library
|
||
|
|
||
|
[![Latest Version](https://img.shields.io/github/tag/oat-sa/lib-lti1p3-core.svg?style=flat&label=release)](https://github.com/oat-sa/lib-lti1p3-core/tags)
|
||
|
[![License GPL2](http://img.shields.io/badge/licence-GPL%202.0-blue.svg)](http://www.gnu.org/licenses/gpl-2.0.html)
|
||
|
[![Build Status](https://github.com/oat-sa/lib-lti1p3-core/actions/workflows/build.yaml/badge.svg?branch=master)](https://github.com/oat-sa/lib-lti1p3-core/actions)
|
||
|
[![Tests Coverage Status](https://coveralls.io/repos/github/oat-sa/lib-lti1p3-core/badge.svg?branch=master)](https://coveralls.io/github/oat-sa/lib-lti1p3-core?branch=master)
|
||
|
[![Psalm Level Status](https://shepherd.dev/github/oat-sa/lib-lti1p3-core/level.svg)](https://shepherd.dev/github/oat-sa/lib-lti1p3-core)
|
||
|
[![Packagist Downloads](http://img.shields.io/packagist/dt/oat-sa/lib-lti1p3-core.svg)](https://packagist.org/packages/oat-sa/lib-lti1p3-core)
|
||
|
[![IMS Certified](https://img.shields.io/badge/IMS-certified-brightgreen)](https://site.imsglobal.org/certifications/open-assessment-technologies-sa/tao-lti-13-devkit)
|
||
|
|
||
|
> [IMS certified](https://site.imsglobal.org/certifications/open-assessment-technologies-sa/tao-lti-13-devkit) PHP library for [LTI 1.3 Core](http://www.imsglobal.org/spec/lti/v1p3) implementations as [platforms and / or as tools](http://www.imsglobal.org/spec/lti/v1p3/#platforms-and-tools).
|
||
|
|
||
|
## Table of contents
|
||
|
|
||
|
- [TAO LTI 1.3 PHP framework](#tao-lti-13-php-framework)
|
||
|
- [IMS](#ims)
|
||
|
- [Installation](#installation)
|
||
|
- [Documentation](#documentation)
|
||
|
- [Wiki](#wiki)
|
||
|
- [Tests](#tests)
|
||
|
|
||
|
## TAO LTI 1.3 PHP framework
|
||
|
|
||
|
This library is part of the [TAO LTI 1.3 PHP framework](https://oat-sa.github.io/doc-lti1p3/).
|
||
|
|
||
|
## IMS
|
||
|
|
||
|
You can find below [IMS](https://www.imsglobal.org/) related information.
|
||
|
|
||
|
### Related certifications
|
||
|
|
||
|
- [LTI 1.3 advantage complete](https://site.imsglobal.org/certifications/open-assessment-technologies-sa/tao-lti-13-devkit)
|
||
|
- [LTI 1.3 proctoring services](https://site.imsglobal.org/certifications/open-assessment-technologies-sa/tao-lti-13-devkit)
|
||
|
|
||
|
### Related specifications
|
||
|
|
||
|
- [IMS LTI 1.3 Core](http://www.imsglobal.org/spec/lti/v1p3)
|
||
|
- [IMS Security](https://www.imsglobal.org/spec/security/v1p0)
|
||
|
|
||
|
## Installation
|
||
|
|
||
|
```console
|
||
|
$ composer require oat-sa/lib-lti1p3-core
|
||
|
```
|
||
|
|
||
|
## Documentation
|
||
|
|
||
|
You can find below the library documentation, presented by topics.
|
||
|
|
||
|
### Quick start
|
||
|
|
||
|
- how to [configure the core library](doc/quickstart/configuration.md)
|
||
|
- how to [implement the core library interfaces](doc/quickstart/interfaces.md)
|
||
|
- how to [expose a JWKS endpoint](doc/quickstart/jwks.md)
|
||
|
|
||
|
### Messages interactions
|
||
|
|
||
|
- how to [handle platform originating LTI messages](doc/message/platform-originating-messages.md)
|
||
|
- how to [handle tool originating LTI messages](doc/message/tool-originating-messages.md)
|
||
|
|
||
|
### Services interactions
|
||
|
|
||
|
- how to [set up an LTI service server](doc/service/service-server.md)
|
||
|
- how to [use the LTI service client](doc/service/service-client.md)
|
||
|
|
||
|
## Wiki
|
||
|
|
||
|
You can find more information in the [library wiki](https://github.com/oat-sa/lib-lti1p3-core/wiki).
|
||
|
|
||
|
## Tests
|
||
|
|
||
|
To run tests:
|
||
|
|
||
|
```console
|
||
|
$ vendor/bin/phpunit
|
||
|
```
|
||
|
**Note**: see [phpunit.xml.dist](phpunit.xml.dist) for available test suites.
|