Skip to content

Gets data from specified locations and creates a CSV for azubiheft.

License

Notifications You must be signed in to change notification settings

pascal-zarrad/webuntis-lessontopic

 
 

Repository files navigation

WebUntis LessonTopic Generator

The plan is to get the lesson topic data from WebUntis so you can generate a file which then can be copy pasted into your azubiheft so you have less work to do yourself.

Warning:

This is still in heavy development and also just a side project so don't expect much code quality or functionality and customizability yet.

Feature checklist:

  • Get data from WebUntis
  • Sort data (Day, Class and Topic)
  • Make data customizable

commit-info contributors-info reposize-info


Contributing

If you want to take part in contribution, like fixing issues and contributing directly to the code base, plase visit the How to Contribute document.

Requirements:

Getting started:

  1. Clone the repository
git clone https://github.com/elias-knodel/webuntis-lessontopic.git
  1. Go in the folder
cd webuntis-lessontopic
  1. Setup your authentication credentials for WebUntis
cp json/secret.example.json json/secret.json

(ONLY FILL THE NOW GENERATED secret.json WITH YOUR CREDENTIALS! THIS FILE IS IGNORED BY GIT AND WILL NOT BE PUSHED!)

  1. Install needed packages (we use pnpm as a package manager)
pnpm install

Commands for developing:

  • Compiles on file-save for development
pnpm run autobuild
  • Compiles and minifies for production
pnpm run build
  • Lints and fixes files
pnpm run lint

Useful links:

License - Contributing - Code of conduct - Issues - Pull requests - Security


Copyright (c) Elias-Knodel. All rights reserved | Licensed under the MIT license. | 2021

About

Gets data from specified locations and creates a CSV for azubiheft.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 100.0%