Tj1 - Turnier Manager Readme
Zweck des Projekts:
Das Projekt Tj1 zielt darauf ab, einen Turnier-Manager zu entwickeln, der es ermöglicht, Turniere zu erstellen, bei denen jeweils zwei Teams gegeneinander antreten und nur der Gewinner in die nächste Runde gelangt. Die Software wird dynamisch Gruppen erstellen, basierend auf der Anzahl der teilnehmenden Teams, und die Teams zufällig auf diese Gruppen aufteilen. Dadurch ist die Möglichkeit gegeben, schnell und effizient Turniere zu organisieren und durchzuführen.
Installation:
Windows:
- Installiere Docker Desktop für Windows von der offiziellen Docker-Website.
- Öffne die Docker Desktop-Anwendung nach der Installation und stelle sicher, dass Docker läuft.
- Öffne ein Terminal wie PowerShell oder CMD.
- Navigiere zum Verzeichnis "student-tournament-hub".
- Führe den Befehl docker compose up --build aus, um das Docker-Image zu starten und einen Container zu erstellen.
- Besuche im Browser die Adresse http://localhost:5173/.
Funktionsbeschreibung:
Grundlegende Verwendung des Projekts:
Landingpage: Auf der Landingpage ist es über die Auswahlliste möglich, auf verschiedene Funktionen zuzugreifen.
- Home: Zurück zur Landingpage.
- Support: Noch nicht implementiert!
- Options: Noch nicht implementiert!
- Light/Dark Mode Toggle: Ändert das Erscheinungsbild der Auswahlleiste zwischen hell und dunkel.
- Register: Leitet auf die Registrierungsseite weiter.
- Login/Create: Leitet auf die Anmeldeseite weiter. Wenn bereits angemeldet (und die Seite neu geladen wurde), erscheint das "Create Tournament" Overlay.
- Tournaments: Leitet auf die Turnierübersichtsseite weiter.
Registry page: Hier ist es möglich, ein Konto anzulegen, indem man sich mit E-Mail und Passwort anmeldet. Nach anschließender Bestätigung der Bestätigungsmail ist das Konto verifiziert.
Login page: Mit einem verifizierten Konto kann man sich anmelden. Nach erfolgreicher Anmeldung landet man auf der Landingpage. Normalerweise sollte "Login" jetzt mit "Create" ersetzt werden, was aber gerade nicht funktioniert. Also einmal die Seite neu laden, anschließend sollte "Create" sichtbar sein.
Create Overlay: Über "Create" erscheint ein Overlay, mit dem man ein Turnier erstellen kann, indem man dem Turnier einen Namen gibt und bei "Teamname" ist es möglich, mehrere Teams einzufügen, indem man einen Teamnamen eingibt und anschließend Enter betätigt. Durch Betätigen von "Senden" gelangt man auf die Turnierverwaltungsseite, wobei die erstellten Teams übernommen werden.
Turnierverwaltungsseite: Über das Eingabefeld ist es noch möglich, vor dem Start des Turniers weitere Teams hinzuzufügen. Sobald man das Turnier über "Start Tournament" startet, wird ein Turnierbaum generiert. Nun ist es möglich, in den Matches den Punktestand der sich gegenüberstehenden Teams hochzuzählen. Wenn "Close Match" betätigt wird, gelangt das Team mit der höheren Punktzahl in das nächste Match.
Turnierübersichtsseite: Hier bekommt man einen Überblick aller Turniere, die man erstellt hat, und kann diese auswählen, um auf die dazugehörige Turnierverwaltungsseite zu gelangen.