Skip to content
This repository has been archived by the owner on Dec 9, 2022. It is now read-only.

Installation

Dominic Plein edited this page Jul 31, 2020 · 6 revisions

Installation der Software

Front-End

Voraussetzungen

  • Webserver mit Support für HTTP 1.1 oder höher
  • Empfohlen: Docker

Mit Docker (Empfohlen)

Wie auch bei der API muss die SSL Unterstützung im Moment manuell konfiguriert werden.

Zuerst das Image herunterladen:

docker pull docker.pkg.github.com/studentsagainstcovid19/corona-aid/corona-aid-frontend:<VERSION>

Danach den Container starten:

docker run -p <PORT>:80 --name sac19_frontend docker.pkg.github.com/studentsagainstcovid19/corona-aid/corona-aid-frontend:<VERSION>

Ohne Docker

Möchte man auf Tools wie z.B. Docker verzichten, ist dies natürlich auch problemlos möglich.

Als erstes muss die Git Repository geklont werden.

git clone https://github.com/StudentsAgainstCovid19/corona-aid/

Für das Front-End relevent sind nur die Dateien im ./src Ordner. Der Inhalt dieses Ordners wird nun in das jeweilige Verzeichnis auf dem Webserver kopiert.

⚠ ACHTUNG: Der Webserver muss im Moment zwingend mit dem Port 63343 oder 63342 gestartet werden!

Lokaler Werbserver mit Python

Eine einfache Möglichkeit, das Frontend lokal zu testen, bietet die im src-Ordner gelegene Datei runLocalServer.py. Ist unter Windows für Python eine globale Umgebungsvariable eingerichtet, kann der lokale http-Server mit folgendem Command gestartet werden (im src-Folder des Projekts): python runLocalServer.py.

XAMPP

Soll kein Python-Server verwendet werden, empfehlen wir unter Windows die Verwendung von XAMPP.

Nach der Installation kann über das XAMPP Control Panel der Port geändert werden (Control Panel -> Konfig Button in der Zeile vom Modul 'Apache' -> Apache (httpd.conf) -> Port unter dem Eintrag Listen auf einen der obrigen Ports abändern).

Anschließend kann der Inhalt des Ordners src aus dem Ordner des vorher geklonten Repositorys (git clone Schritt) in das Verzeichnis C:\xampp\htdocs\corona-aid kopiert werden, wenn bei der Installation kein anderer Pfad spezifiziert wurde.

Über einen Internetbrowser kann nun das Front-End unter http://localhost:63343/corona-aid/ oder http://localhost:63342/corona-aid/ erreicht werden.

Back-End

Voraussetzungen

  • Java 11
  • Eine MySQL Datenbank
  • Empfohlen: Docker
  • Empfohlen: Proxy, über den man sich per HTTPS verbinden kann, da sich die API selbst im Moment nicht mit SSL konfigurieren lässt

Mit Docker (Empfohlen)

Zuerst muss das Docker Image von GitHub Packages heruntergeladen werden. Um die aktuellste Version herunterzuladen kann statt einer spezifischen Version latest verwendet werden.

docker pull docker.pkg.github.com/studentsagainstcovid19/corona-aid-api/corona-aid:<version>

Als nächstes kann der Container mit entsprechenden Umgebungsvariablen und Port-Mappings gestartet werden. Die API selbst startet innerhalb des Docker Containers auf Port 8080.

docker run -p <PORT>:8080 --name sac19_backend -e "SAC19_MYSQL_HOST=<HOST>" -e "SAC19_MYSQL_USER=api" -e "SAC19_MYSQL_PASSWORD=1234" docker.pkg.github.com/studentsagainstcovid19/corona-aid-api/corona-aid:<VERSION>

Ohne Docker

Voraussetzungen

  • Kotlin Compiler (Version 1.3.72 oder höher)
  • Maven

Bevor das Projekt kompiliert werden kann, muss die Repository geklont werden.

git clone https://github.com/StudentsAgainstCovid19/corona-aid/

Anschließend mit einem Terminal in den heruntergeladenen Ordner navigieren und folgenden Befehl ausführen:

mvn package -DskipTests

Eine ausführbare jar Datei befindet sich nun im Ordner ./target. Die Datei selbst trägt standartmäßig den Namen api.jar Diese Datei kann nun auf jeden beliebigen Host deployed werden