JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 676
  • Score
    100M100P100Q146797F
  • License Apache-2.0

Ltijs Sequelize Database Plugin

Package Exports

  • ltijs-sequelize

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ltijs-sequelize) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme



IMS Global Certified

Ltijs Sequelize Database Plugin.

travisci codecov Node Version NPM package NPM downloads dependencies Status devDependencies Status JavaScript Style Guide APACHE2 License Donate

Please ⭐️ us on GitHub, it always helps!

Ltijs is LTI Advantage Complete Certified by IMS

Table of Contents


Introduction

This package allows Ltijs to work with the databases supported by Sequelize.


Installation

$ npm install ltijs-sequelize

Usage

Setup the plugin just like you would Sequelize.

const path = require('path')

// Require Provider 
const lti = require('ltijs').Provider
const Database = require('ltijs-sequelize')

// Setup ltijs-sequelize
const db = new Database('database', 'user', 'password', { host: 'localhost', dialect: 'mysql', logging: false })

// Setup provider
lti.setup('LTIKEY', // Key used to sign cookies and tokens
         { plugin: db }, // 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()

Contributing

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.

Buy Me A Coffee

Main contributors

Carlos Costa
Carlos Costa

💻💬 📖 👀 📢
Lucas Terças
Lucas Terças

📖 🔧
Micael Gomes
Micael Gomes

🎨

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.


License

APACHE2 License