Easily turn your web application into into a LTI 1.3 Learning Tool.
Please ⭐️ us on GitHub, it always helps!
Ltijs version 5.0 is a re-release of the project as a Certified LTI library, that comes with many improvements and new functionalities and a few API changes, see bellow for a migration guide from version 4.0 and a complete list of the changes made:
- Introduction
- Feature roadmap
- Installation
- Tutorial
- Usage
- Documentation
- Contributing
- Special thanks
- License
According to the IMS Global Learning Consortium, the Learning Tools Interoperability (LTI) protocol is an IMS standard for integration of rich learning applications within educational environments. ref
This framework implements a tool provider as an Express server, with preconfigured routes and methods that manage the LTI 1.3 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 | Implementation | Documentation |
---|---|---|
Keyset endpoint support | ✔️ | ✔️ |
Deep Linking Service Class | ✔️ | ✔️ |
Grading Service Class | ✔️ | ✔️ |
Names and Roles Service Class | ✔️ | ✔️ |
Database plugins | ✔️ | ✔️ |
Key Rotation | ||
Redis caching |
$ npm install ltijs
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.
Ltijs can also be used with other databases through database plugins that use the same structure as the main database class.
You can find a quick tutorial on how to set Ltijs up and use it to send grades to a Moodle platform here.
Install Ltijs
$ npm install ltijs
Install mongoDB
Setting up Ltijs
const path = require('path')
// Require Provider
const lti = require('ltijs').Provider
// Setup provider
lti.setup('LTIKEY', // Key used to sign cookies and tokens
{ url: 'mongodb://localhost/database' }, // Database configuration
{ appRoute: '/', loginRoute: '/login' }) // Optionally, specify some of the reserved routes
// 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()
See bellow for the complete documentation:
Service documentations:
- Deep Linking Service documentation
- Grading Service documentation
- Names and Roles Provisioning Service documentation
Additional documentation:
Please ⭐️ us on GitHub, 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, pull requests are also welcome :)
And if you feel like it, you can donate any amount through paypal, it helps a lot.
Carlos Costa 💻💬 📖 👀 📢 |
Lucas Terças 📖 🔧 |
Micael Gomes 🎨 |
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.