Hier eine kleine Anleitung / Guide zu der Studienarbeit der Gruppe Ganic, bestehend aus den Teammitgliedern Julian Liegel, Florian Herrnberger und Ismar Ganic.
Das Projekt kann mittels git geklont werden.
git clone https://gitlab.lrz.de/software-engineering-gruppe-test/gruppe-ganic/gruppe-ganic.git
Die Dateien zu den Anforderungen 1.1 - 1.3 befinden sich im Ordner "Abgabe_Juni" im Stammverzeichnis.
Die Dateien zu der Anforderung 2 (Datenbankschema) befindet sich im Ordner "Abgabe_Juli" -> "Anforderung_2".
Datenbankversion 8.0.33
Die Dateien zu der Anforderung 3 (Datenbankschema) befindet sich im Ordner "Abgabe_Juli" -> "Anforderung_3".
Es wurde ein Kundenregistrierungsprozess mit einem Spring-Boot-Backend gecoded. Die Verwendung einer MySQL-Datenbank ist für dieses Projekt vorgesehen, da im Backend bereits der richtige Treiber hierfür hinterlegt worden ist.
Wir haben uns für dieses Projekt für ein React-Frontend entschieden. Dieses Frontend kann über docker-compose mit dem Backend und der Datenbank gestartet werden, dazu aber mehr bei Anforderung 5.
Falls man das Projekt über docker-compose (empfohlen) startet, ist das Frontend über http://localhost:8081 erreichbar.
Das Frontend besteht aus den Eingabefeldern:
- Name (Muss-Feld)
- E-Mail (Muss-Feld)
- Passwort (Muss-Feld, mindestens 10 Zeichen, 1 Symbol, 1 Zeichen)
- Straße (optional)
- PLZ (optional)
- Ort (optional)
Außerdem kann der Inhalt der SQL-Datenbank über den "Refresh"-Button angezeigt werden.
Dieser Schritt kann übersprungen werden! Das Ausführen von docker-compose aus Anforderung 5.2 + 5.3 erledigt den "docker build"-Vorgang bereits von selbst. Hier ist lediglich, aus Dokumentationszwecken, aufgeführt wie man ein Docker-Image für das Spring-Boot-Backend aus dem Jar-File erzeugt.
In unserem GitLab-Repository ist bereits eine Jar-Datei enthalten aus der ein Docker-Image erzeugt werden kann. Das Dockerfile dazu befindet sich im Stammverzeichnis.
(Optional)
docker build -t spring_studienarbeit .
Der einfachste Weg um das Projekt zum Laufen zu bekommen ist mittels docker-compose. Dazu einfach folgendes im Stammverzeichnis ausführen:
docker-compose up
Damit werden mithilfe der docker-compose.yml drei Docker-Container erzeugt:
- MySQL Datenbank
- Spring-Boot-Backend
- React-Frontend
Das Erzeugen der Images/Container kann tatsächlich eine ganze Zeit lang dauern (je nachdem wie schnell der Rechner ist 2 - 6 Minuten...). Bitte einfach paar Minuten abwarten bis dieser Vorgang abgeschlossen ist. Anschließend startet die Spring-Boot-Applikation paar mal neu, da die SQL-Datenbank noch nicht fertig eingerichtet ist, bitte auch hier warten bis alle Dienste durch-gestartet sind. Anschließend können Sie unter http://localhost:8081 das React-Frontend aufrufen und Eingaben tätigen.