Skip to content
This repository has been archived by the owner on Sep 5, 2023. It is now read-only.

Latest commit

 

History

History
59 lines (39 loc) · 3.24 KB

README.md

File metadata and controls

59 lines (39 loc) · 3.24 KB
Raw

Github actions badge codecov Conventional Commits Imports: isort Code style black

IllumiDesk

This monorepo is used to maintain IllumiDesk's authenticators, spawners, and microservices. This setup assumes that all services are running with Kubernetes. Please refer to our help guides for more information.

Overview

Jupyter Notebooks are a great education tool for a variety of subjects since it offers instructors and learners a unified document standard to combine markdown, code, and rich visualizations. With the proper setup, Jupyter Notebooks allow organizations to enhance their learning experiences.

When combined with the nbgrader package instructors are able to automate much of tasks associated with grading and providing feedback for their users.

Why?

Running a multi-user setup using JupyterHub and nbgrader with containers requires some additional setup. Some of the questions this distribution attempts to answer are:

  • How do we manage authentication when the user isn't a system user within the JupyterHub or Jupyter Notebook container?
  • How do we manage permissions for student and instructor folders?
  • How do we securely syncronize information with the Learning Management System (LMS) using the LTI 1.1 and LTI 1.3 standards?
  • How do we improve the developer experience to provide more consistency with versions used in production, such as with Kubernetes?
  • How should deployment tools reflect these container-based requirements and also (to the extent possible) offer users an option that is cloud-vendor agnostic?

Our goal is to remove these obstacles so that you can get on with the teaching!

Prerequisites

Kubernetes v1.17+.

Quick Start

This setup only supports Kubernetes-based installations at this time. Refer to the helm-chart repo for installation instructions.

Development Installation

Refer to the contributing guide located in the root of this repo.

Building the JupyterHubs

  1. Build the JupyterHub for local testing with docker-compose or docker:
make build-hubs
  1. Build the JupyterHub for local testing with Kubernetes:
make build-hubs-k8

General Guidelines

This project enforces the Contributor Covenant. Be kind and build a nice open source community with us. ++

License

Please refer to the included license in this repository's root directory.