Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Cvmcosta/ltijs
Turn your application into a fully integratable LTI 1.3 tool provider.
https://github.com/Cvmcosta/ltijs
Last synced: 4 days ago
JSON representation
Turn your application into a fully integratable LTI 1.3 tool provider.
- Host: GitHub
- URL: https://github.com/Cvmcosta/ltijs
- Owner: Cvmcosta
- License: apache-2.0
- Created: 2019-05-30T11:49:49.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-20T23:56:55.000Z (about 2 months ago)
- Last Synced: 2024-10-02T07:39:07.352Z (about 1 month ago)
- Language: JavaScript
- Homepage: https://cvmcosta.github.io/ltijs/
- Size: 4.79 MB
- Stars: 297
- Watchers: 21
- Forks: 65
- Open Issues: 52
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
> Easily turn your web application into a LTI® 1.3 Learning Tool.
[](https://codecov.io/gh/Cvmcosta/ltijs)
[](https://www.npmjs.com/package/ltijs)
[](https://www.npmjs.com/package/ltijs)
[](https://www.npmjs.com/package/ltijs)
[](https://standardjs.com)
[](#license)
[](https://www.buymeacoffee.com/UL5fBsi)
Please ⭐️ us on [GitHub](https://github.com/Cvmcosta/ltijs), it always helps!
> [Ltijs is LTI® Advantage Complete Certified by IMS](https://site.imsglobal.org/certifications/coursekey/ltijs)
> Ltijs is the first LTI Library to implement the new [LTI® Advantage Dynamic Registration Service](https://cvmcosta.me/ltijs/#/dynamicregistration), now supported by **Moodle 3.10**.
> The Dynamic Registration Service turns the LTI Tool registration flow into a fast, completely automatic process.
> - [Migrating from version 4](https://cvmcosta.github.io/ltijs/#/migration)
> - [CHANGELOG](https://cvmcosta.github.io/ltijs/#/changelog)
---
## LTI As A Service
> A ready-to-go SaaS LTI solution.
If you need an enterprise-ready LTI deployment, LTIaaS can get you up and running in a matter of minutes. We offer a SaaS solution with a powerful, easy to use, API that gives you access to the entire functionality of the LTI protocol. And you only start paying once your product starts to grow.
Through our consultation services we can help you design, build and maintain your LTI tool. The LTIaaS API is already being used to reach thousands of students across the entire world!
> For more information visit [LTIaaS.com](https://ltiaas.com)
> - [Documentation and Guides](https://ltiaas.com/guides/introduction)
> - [Pricing information and simulator](https://ltiaas.com/pricing/)
> - [Contact us](https://ltiaas.com/contact-us/)
> - [LTIJS vs LTIAAS](https://cvmcosta.me/ltijs/#/ltijs-vs-ltiaas)
---
## Table of Contents
- [Introduction](#introduction)
- [Feature roadmap](#feature-roadmap)
- [Installation](#installation)
- [Quick start](#quick-start)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [Special thanks](#special-thanks)
- [License](#license)
---
## Introduction
The Learning Tools Interoperability (LTI®) protocol is a standard for integration of rich learning applications within educational environments. [ref](https://www.imsglobal.org/spec/lti/v1p3/)
This library implements a tool provider as an [Express](https://expressjs.com/) server, with preconfigured routes and methods that manage the [LTI® 1.3](https://www.imsglobal.org/spec/lti/v1p3/) protocol for you. Making it fast and simple to create a working learning tool with access to every LTI® service, without having to worry about manually implementing any of the security and validation required to do so.
---
## Feature roadmap
| Feature | Implementation | Documentation |
| --------- | - | - |
| [Keyset endpoint support](https://cvmcosta.me/ltijs/#/provider?id=keyset-endpoint) | ✔️ | ✔️ |
| [Deep Linking Service Class](https://cvmcosta.me/ltijs/#/deeplinking) | ✔️ | ✔️ |
| [Grading Service Class](https://cvmcosta.me/ltijs/#/grading) | ✔️ | ✔️ |
| [Names and Roles Service Class](https://cvmcosta.me/ltijs/#/namesandroles) | ✔️ | ✔️ |
| [Dynamic Registration Service ](https://cvmcosta.me/ltijs/#/dynamicregistration) | ✔️ | ✔️ |
| Database plugins | ✔️ | ✔️ |
| Revised usability tutorials | | |
| Key Rotation | | |
| Redis caching | | |
---
## Installation
### Installing the package
```shell
$ npm install ltijs
```
### MongoDB
This package natively uses mongoDB by default to store and manage the server data, so you need to have it installed, see link bellow for further instructions.
- [Installing mongoDB](https://docs.mongodb.com/manual/administration/install-community/)
### Database Plugins
Ltijs can also be used with other databases through database plugins that use the same structure as the main database class.
- [Firestore Plugin](https://github.com/examind-ai/ltijs-firestore)
- [Sequelize Plugin](https://github.com/Cvmcosta/ltijs-sequelize)(MySQL, PostgreSQL)
---
## Quick start
> Setting up Ltijs
```javascript
const path = require('path')
// Require Provider
const lti = require('ltijs').Provider
// Setup provider
lti.setup('LTIKEY', // Key used to sign cookies and tokens
{ // Database configuration
url: 'mongodb://localhost/database',
connection: { user: 'user', pass: 'password' }
},
{ // Options
appRoute: '/', loginRoute: '/login', // Optionally, specify some of the reserved routes
cookies: {
secure: false, // Set secure to true if the testing platform is in a different domain and https is being used
sameSite: '' // Set sameSite to 'None' if the testing platform is in a different domain and https is being used
},
devMode: true // Set DevMode to false if running in a production environment with https
}
)
// Set lti launch callback
lti.onConnect((token, req, res) => {
console.log(token)
return res.send('It\'s alive!')
})
const setup = async () => {
// Deploy server and open connection to the database
await lti.deploy({ port: 3000 }) // Specifying port. Defaults to 3000
// Register platform
await lti.registerPlatform({
url: 'https://platform.url',
name: 'Platform Name',
clientId: 'TOOLCLIENTID',
authenticationEndpoint: 'https://platform.url/auth',
accesstokenEndpoint: 'https://platform.url/token',
authConfig: { method: 'JWK_SET', key: 'https://platform.url/keyset' }
})
}
setup()
```
### Implementation example
- [Example Ltijs Server](https://github.com/Cvmcosta/ltijs-demo-server)
- [Example Client App](https://github.com/Cvmcosta/ltijs-demo-client)
---
## Documentation
See bellow for the complete documentation:
### [Ltijs Documentation](https://cvmcosta.github.io/ltijs/#/provider)
Service documentations:
- [Deep Linking Service documentation](https://cvmcosta.github.io/ltijs/#/deeplinking)
- [Grading Service documentation](https://cvmcosta.github.io/ltijs/#/grading)
- [Names and Roles Provisioning Service documentation](https://cvmcosta.github.io/ltijs/#/namesandroles)
- [Dynamic Registration Service documentation](https://cvmcosta.me/ltijs/#/dynamicregistration)
Additional documentation:
- [Platform class documentation](https://cvmcosta.github.io/ltijs/#/platform)
---
## Contributing
Please ⭐️ us on [GitHub](https://github.com/Cvmcosta/ltijs), it always helps!
If you find a bug or think that something is hard to understand feel free to open an issue or contact me on twitter [@cvmcosta](https://twitter.com/cvmcosta), pull requests are also welcome :)
And if you feel like it, you can donate any amount through paypal, it helps a lot.
---
## Special thanks
> I would like to thank the Federal University of Maranhão and UNA-SUS/UFMA for the support throughout the entire development process.
> I would like to thank CourseKey for making the Certification process possible and allowing me to be an IMS Member through them, which will contribute immensely to the future of the project.
> I would like to thank Examind for the amazing work on the Firestore database plugin. As well as the continuous help and support in the development of this project.
---
## License
[](LICENSE)
> *Learning Tools Interoperability® (LTI®) is a trademark of the IMS Global Learning Consortium, Inc. (https://www.imsglobal.org)*