Gradebook plugin for Tutor

This Tutor plugin adds the Gradebook microfrontend to an Open edX installation.

⚠️ THIS PLUGIN IS NOW DEPRECATED IN FAVOUR OF THE MFE PLUGIN https://github.com/overhangio/tutor-mfe/ ⚠️

This plugin has the following limitations:

• Works with Tutor >= 10.2.2
• Not compatible with Kubernetes deployment
• This plugin is not supported yet and will probably be extensively modified before it is included in the official list of supported Tutor plugins.

Installation

pip install git+https://github.com/overhangio/tutor-gradebook

Usage

Enable the plugin:

tutor plugins enable gradebook

You will need to compile the "frontend-base" and "gradebook" images yourself:

tutor images build frontend-base gradebook

Initialize the Gradebook service:

tutor local quickstart
# or, faster if you've already run quickstart:
tutor local init --limit=gradebook

Then, follow the Open edX documentation on enabling the Gradebook: https://github.com/edx/frontend-app-gradebook/#configuring-for-local-use-in-edx-platform The settings do not need to be modified, but you will need to enable several waffle flags and switches.

The gradebook will then be available for every course at the following urls:

• In development: http://grades.local.overhang.io:1994/<course-id>
• In production: http(s)://grades.{{ LMS_HOST }}/<course-id>

Configuration

• GRADEBOOK_FRONTEND_BASE_DOCKER_IMAGE (default: "{{ DOCKER_REGISTRY }}overhangio/openedx-frontend-base:{{ GRADEBOOK_VERSION }}")
• GRADEBOOK_DOCKER_IMAGE (default: "{{ DOCKER_REGISTRY }}overhangio/openedx-gradebook:{{ GRADEBOOK_VERSION }}")
• GRADEBOOK_HOST (default: "grades.{{ LMS_HOST }}")

License

This software is licensed under the terms of the AGPLv3.