-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
34 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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= |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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`. | ||
|