David Weinberger, Arno Blümel
v1.0.1
2020-04-16
1. Pflichtenheft
1.1. Ausgangssituation
Die HTL-Leonding hat viele Klassen, die auf ein großes Schulgebäude verteilt sind. Beginn und Ende jeder Unterrichtseinheit werden durch das Läuten der Pausenglocke signalisiert.
1.2. Problem
Die Klingel ist nicht in jeder Klasse immer zu hören. Besonders in den abgelegeneren Klassen an den äußeren Enden des Gebäudes, für die unter Umständen nur eine Klingel in Reichweite ist, kann das dazu führen, dass die Pause bis in die nächste Einheit durchgearbeitet wird, und Schüler sowie Lehrer zu spät zu ihrer nächsten Stunde erscheinen, wenn diese eine Klingel ausfällt.
1.3. Ziel
Es soll eine App entwickelt werden, die den Nutzer benachrichtigt, wenn eine Stunde beginnt bzw. endet. Die Benachrichtigung soll nur erfolgen, wenn es für den betroffenen Nutzer auch tatsächlich eine Unterrichtseinheit ist/war. Die dazu benötigten Daten sind aus dem WebUntis der HTL-Leonding zu beziehen.
2. Installation
2.1. Informationen zur Verwendung
-
Das Funktionieren der App setzt einen Zugang zum WebUntis-System der HTL-Leonding voraus.
-
Die App ist standarmäßig auf den Server unter der Addresse vm109.htl-leonding.ac.at programmiert. Für die Verwendung eines eigenen Servers muss das Projekt im Android-Studio geöffnet und die String-Ressource entsprechend neu gesetzt werden.
2.2. Server
2.2.2. Installation
Um den Server zu installieren und zu starten, müssen im Verzeichnis "BreakNotifierAndroid" des gekloneten Repos folgende Befehle ausgeführt werden:
mvn package
docker build -f src/main/docker/Dockerfile.jvm -t quarkus/breaknotifierbackend-jvm .
docker run -i -d --rm -p 80:13131 quarkus/breaknotifierbackend-jvm
Setzen der neuen URL in der Android-App:
In der Datei BreaknotifierLit/app/src/main/res/values/strings.xml muss die Ressource mit dem Namen "server_ip" geändert werden. Danach muss eine neue .apk-Datei aus dem Projekt generiert werden (in Android-Studio). Danach kann wie in Abschnitt 2.2 verfahren werden.
2.3. Android-Applikation
2.3.1. Installation
Die .apk-Datei kann in den Releases des GitHub-Repositorys heruntergeladen werden. Um die App zu installieren reicht es normalerweise, die .apk im Dateimanager zu öffnen. Bei manchen Android-Versionen muss die .apk mit einem externen Tool installiert werden.
