Tutors: An Open Learning Web Toolkit

Website | Documentation | Discord

What is Tutors?

A collection of open source components & services supporting the creation of transformative learning experiences using open web standards. Some representative examples:

• Higher Diploma in Computer Science Portal
• Full Stack Development
• Reference Course
• Higher Diploma in Computer Science at SETU: 2020-2022
• Classic Design Patterns
• Agile Software Development
• Technologische Fähigkeiten

Getting Started

Make sure you have Node 16 + installed, and start by cloning this repo:

git clone https://github.com/tutors-sdk/tutors.git

Open a shell and...

cd tutors
npm install

Change directory into the app folder

cd app

and copy the file .env.example to .env

cp .env.example .env

Now to start the app you can run this command from the root:

npm run app

Or this command from the app folder:

npm run dev

You should see an output similar to below:

tutors-app@9.0.0 dev
vite dev --port 3000 --open


VITE v4.4.9  ready in 966 ms

 ➜  Local:   http://localhost:3000/
 ➜  Network: use --host to expose

Now the app is up and running and you can browse to it by opening the local location in your browser.

The app encompasses all web components of the Tutors project, and the course reader component relies on a segment of the url to locate the course to display. Any of the samples above can be 'read' with an appropriate url segments appended to the local url you now have running. So for instance:

https://tutors.dev/course/tutors-reference

... can be loaded locally by:

http://localhost:3000/course/tutors-reference

(Note the port number may vary - for example 3000)

The 'source' for the above course is here:

• https://github.com/tutors-sdk/tutors-template

You could try any of the other sample courses above.

If you would like to build your own course then this workshop here would be a good place to start. In particular, this lab here will get you up and running with a sample course in a few minutes. More guidance and examples are on our Educator documentation site. To learn more about the project, explore the core principles at https://tutors.dev/.

If you have VSCode, you should be able to open the project.

Project Structure

This is a monorepo for all of the components & services of the Tutors Open Source Project.

App

The app is the student facing web application for browsing a course, inspecting course analytics + a storybook encapsulation of UX elements. It is a SvelteKit application that renders a course in an appealing, context sensitive user experience. The principles embodied in the learner experience are presented here.

The app contains grouped routes, sectioned for their purpose. These are explained below:

home

The homepage of Tutors app.

auth

The authentication routes of the app. The app uses Supabase for authentication, using GitHub as the OAuth provider.

course-reader

The main Tutors user experience - demonstrated in the links above. This can be built and launched via the instructions above.

time

This route presents the educational analytics gathered by the application. There is a student + an educator perspective.

CLI

These are command line applications used by educators to generate courses. The principles embodied in the educator experience are presented here.

tutors-gen-lib

// Todo

tutors-publish

// Todo

tutors-publish-html

// Todo

Contributing

Please ensure to read the Code of Conduct before contributing to the Tutors project.

When contributing, pull requests should be opened to the 'development' branch, and once tested this will be merged to main.

All contributors are eligible to earn a Holopin - a digital badge that represents your contributions to the project. These badges evolve the more contributions you make to the project!

Every time you open a PR that is accepted, you will be assigned holobytes. Collect these holobytes to see your owl evolve!

Sponsors

This project is powered by Netlify Open Source.

License

This project is licensed under the terms of the MIT License.