datadotworld/data.world-lti

LTI connector for data.world

data.world LTI Connector

LTI compliant LMS connector for data.world

Getting Started

Quick Start

Installation and Build

npm install
npm run build
npm run start

Testing

Unit

Unit tests can be run with the following command:

npm run test

Integration

Just in case one wants to take a peak inside a running LMS instance.

1. Spin up a test instance of Canvas linked with the LTI running in another container. More info about the lbjay/canvas-docker container can be found over at DockerHub.

docker-compose up --build

2. After the containers build and are running, point your browser to http://localhost:3000 and login.

• Username: [email protected]
• Password: canvas-docker

3. Create a new course in Canvas and the follow the installation instructions in the FAQ.

You might have to navigate out from the application installation area to the main course page for the side bar link to propagate.

Configuration Variables

• DDW_CLIENT_ID - data.world OAuth Client ID
• DDW_LTI_CONFIGURATION_HOST - The LTI configuration URL that will be used in the LTI installation FAQ.
• DDW_LTI_LAUNCH_HOST - The publicly accessible hostname for LTI content for use in testing.
• DDW_LTI_SECURE - Sets the protocol of dynamically produced URLs from https/http default true
• PORT - default 3000

EduAppCenter Submission Materials

EduAppCenter allows for the submission of markdown for some of the user facing information.

• Description
• Installation Instructions
• Testing Instructions

Contributing

This integration has been released as an open-source project. Community participation is encouraged and highly appreciated. If you'd like to contribute, please follow the Contributing Guidelines.

Support

For support, either create a new issue here on GitHub, or send an email to [email protected].

data.world-lti's Issues

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: Cannot find preset's package (github>datadotworld/renovate-config)

LTI Provider configuration URL displaying default value on FAQ page.

By default, Webpack does not expose environment variables from the shell while it is bundling things up. Thus, the alternate value is being used in the LTI Provider installation instructions.

Many libraries will key off the process.env.NODE_ENV variable to determine what should be included in the library. For example, when not in production some libraries may add additional logging and testing to make debugging easier. However, with process.env.NODE_ENV === 'production' they might drop or add significant portions of code to optimize how things run for your actual users.

https://webpack.js.org/guides/production/#specify-the-environment

data.world-lti/src/client/components/InstallLTITutorial.tsx

Line 10 in 04a1a03

const ltiConfigUrl = process.env.DDW_LTI_CONFIGURATION_URL || "http://example.com/config.xml";