Skip to content

Latest commit

 

History

History
108 lines (73 loc) · 3.72 KB

README.md

File metadata and controls

108 lines (73 loc) · 3.72 KB
Raw

Hola mundo Build Status Code Climate

Overview

This creates a course-level LTI tool that allows your students to introduce themselves via youtube videos or with text only.

Previously these could've been captured from their webcam (via the youtube upload widget iframe API), but google deprecated and removed that API 1/16/2016.

It includes:

  • Instructor controls - including video pre-approval and removal,
  • A responsive design,
  • Basic filter support - name, date, and approval status (where appropriate).

It's built to work with the canvas lms but would probably work with other LMSs without a ton of effort. PRs welcome!

It's built to be deployed to heroku but should be easily deployed elsewhere.

Screenshot

Prerequisites:

  • development A POSIX dev environment,
  • development foreman - not strictly necessary but it makes development easier,
  • ruby 2.2.4 - but ruby > 2.1.x should work great,
  • a postgres database,
  • Manual acceptance testing only: A working LTI application consumer, most likely canvas.

Getting Started

After you have cloned this repo, run this setup script to set up your machine with the necessary dependencies to run and test this app:

% ./bin/setup

After setting up, you can run the application using foreman:

% foreman start

This application uses the dce_lti mountable engine to manage LTI authentication sessions. You should be familiar with it before you deploy - it allows you to manage your consumer key and secret along with other aspects of the LTI transaction.

You can easily get a working canvas-lms environment via our canvas_vagrant project.

Testing

Run bin/setup as described above. We use rspec for unit and integration testing.

% bundle exec rake

Deploying to production or staging

This app follows 12 factor principles and as such configuration is done mostly through environment variables. Environment variables of note:

  • LTI_CONSUMER_KEY: a key shared amongst all consumers. This strategy can be changed in config/initializers/dce_lti.rb.
  • LTI_CONSUMER_SECRET: a secret shared amongst all consumers
  • NEW_RELIC_LICENSE_KEY: your new relic license key: your app should work fine without it.
  • COURSE_NAV_TITLE: The title in the course navigation bar. The default is "Say Hello!".

You should be sure to clean up nonces and sessions with cron via the dce_lti supplied rake tasks - dce_lti::clean_nonces and dce_lti::clean_sessions.

Known issues

  • This application uses the experimental "cookieless sessions" provided by the DceLti sessioning gem.

Contributing or reporting problems

  1. Open a github issue to discuss your problem or feature idea.
  2. Fork this repo. Run ./bin/setup
  3. Make sure tests pass: bundle exec rake
  4. Make your change by writing tests and making sure they pass.
  5. Submit a pull request.

We'll try to review ASAP, please be patient.

Contributors

  • Dan Collis-Puro - djcp

License

This project is licensed under the same terms as Rails itself.

Copyright

2015 President and Fellows of Harvard College