-
Tutors is a collection of open source components and services supporting the creation of transformative learning experiences using open web standards. It consists of two key components:
-
Generator: transforms a folder of learning content into a Tutors course
-
Reader: presents a Tutors course as an intuitive, discoverable and attractive Web experience
This repo is the Tutors Generators repo. A companion repo:
...host the primary Tutors Reader application. These components are developed in the open by an active and friendly community, based on a simple set of values.
-
There are three components making up the generators family of components:
- cli/tutors-gen-lib: A share library encapsulating the core Tutors course model, published to npm here
- cli/tutors-publish: The primary Tutors course generator producing a course for consumption by the Tutors Reader - on npm here.
- cli/tutors-publish-html: A backup generator, which generators a static version of a course.
See the tutors manual for guidance on using the generators command line applications.
There is a component in cli/tutors-json-manager that adds the capability to encyrpt and / or compress the JSON file.
It's a simple standalone CLI tool but more importantly it standardises on a set of libraries and commonalities (such as base64 encoding) so that when this gets implemented in the reader application we can have consistency. Arguments: file JSON file to process
Options: --encrypt Encrypt the file with the specified key --compress Compress the file --key Key to decrypt the file -h, --help display help for command
The rough compression saved % is printed out for convenience but we accept no liability for the accuracy!!
The Tutors Reader has a "live" feature, whereby students who share their presence appear on a real time dashboard summarising their current learning object interactions. This feature relies on the Partykit service, and the tutors-party-kit service component here.
- Tutors: The course reader application. This is a SvelteKit application, written in TypeScript with a user experience implemented using Tailwind & Skeleton.
- Tutors Apps: A monorepo encapsulating the generators, tests + support tools and applications. It is written in TypeScript.
- Tutors Reference Manual: The manual is itself a tutors course, and is largely written in Markdown.
- Tutors Reference Course: A Tutors course to included all tutors learning objects and structures.
This project is licensed under the terms of the MIT License.