Seil0/TheCitadelofRicks
1
1
Fork 0
Code Issues 3 Pull Requests Releases 14 Wiki Activity

„Home“ ändern

Hannes Braun
2021-10-26 17:58:40 +02:00
parent b2d13cf58c
commit d9953a810b
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
Home.md

@ -1,9 +1,9 @@
## Welcome to the "TheCitadelofRicks" wiki!
"TheCitadelofRicks" (tcor for short) is a API for timetable and mensa data of the HS Offenburg.
It's build with spring and kotlin.
"TheCitadelofRicks" (tcor for short) is an API for timetable and mensa data of the HS Offenburg.
It's built with Spring and Kotlin.
tcor currently provides 3 request options. /courses which will return a array "courses" with all currently available courses at the HS Offenburg, /timetable?courseName={coursename}&week={week} which will return a given weeks timetable for a given course and /mensamenu which will return the menu of the mensa for the current and next week.
tcor currently provides 3 request options. /courseList which will return an array "courses" with all currently available courses at the HS Offenburg, /timetable?courseName={coursename}&week={week} which will return a given weeks timetable for a given course and /mensamenu which will return the menu of the mensa for the current and next week.
Since software version 1.2.0 tcor supports cachet api reporting.
@ -29,7 +29,7 @@ Here is an example of the config.xml:
```
### Docker
To build tcor as docker image, execute `docker build -t tcor:latest .` If the build was successfull,
To build tcor as docker image, execute `docker build -t tcor:latest .` If the build was successful,
you can run tcor via `docker run -v {path-to-the-tcor-folder}:/tcor -p 8080:8080 tcor`. You can also use the tcor docker image from dockerhub, see https://hub.docker.com/r/mosadxyz/tcor.
For the docker image to work properly you need to copy a java keystore into the tcor folder (right besides the config.xml file). Also make sure the file is named "cacerts".