Skip to content

Latest commit

 

History

History
34 lines (20 loc) · 1.55 KB

README.md

File metadata and controls

34 lines (20 loc) · 1.55 KB

untis-ics-sync

Node CI Docker CI

Serves a calendar API (ICS) for events provided from Untis.

Use case

Some schools, universities or workspaces do not enable the iCalendar API that Untis provides by default. Due to this limitation I've wrote my own implementation to dynamically sync class schedules to my agenda.

Installation

Simply clone the repository and cd into it.
git clone https://github.com/bddvlpr/untis-ics-sync && cd untis-ics-sync. If you're planning on using Docker, you could use the bddvlpr/untis-ics-sync image from Docker Hub instead of the git repository.

Setup SSL

From version 0.2.6 and forward, SSL will not be natively supported anymore. Please use a reverse proxy instead of supplying the docker container with an ssl certificate.

Using Docker

To run the app using Docker, copy over the .env.example to .env and fill in the parameters to get the app to work.

Deploy the app using docker compose up -d, remove it using docker compose down -v.

Using Yarn

To run the app using Yarn, copy over the .env.example to .env and fill in the parameters to get the app to work.

Hotrun the app using yarn dev, or build it using yarn build.