From d1f7288c57f6301bc90a8752ab0a92009e6b1fbe Mon Sep 17 00:00:00 2001 From: Luna Simons Date: Thu, 21 Sep 2023 10:36:08 +0200 Subject: [PATCH] docs: readded readme --- .env.example | 7 +++++++ README.md | 27 +++++++++++++++++++++++++++ 2 files changed, 34 insertions(+) create mode 100644 .env.example create mode 100644 README.md diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..de4e8a7 --- /dev/null +++ b/.env.example @@ -0,0 +1,7 @@ +UNTIS_SCHOOLNAME= +UNTIS_USERNAME= +UNTIS_PASSWORD= +UNTIS_BASEURL= + +# Optionally set the cors origin to use with untis-ics-sync-ui +#CORS_ORIGIN= diff --git a/README.md b/README.md new file mode 100644 index 0000000..9177e3b --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# untis-ics-sync + +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 written my implementation to dynamically sync class schedules to my agenda. + +## Installation + +Simply clone the repository and cd into it using `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](https://hub.docker.com/r/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 (in a test environment) using `docker run -d --env-list .env -p 3000:3000 bddvlpr/untis-ics-sync`. + +### 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. +Hot run the app using `yarn start:dev`, or build it using `yarn build`. +