TowerDefence/Dokumentation
6
0
Fork 0
Code Wiki Activity

Guides/Development Setup aktualisiert

Snoweuph 2025-02-02 21:27:18 +00:00 • committed by Euph Forge
parent dec6f51844
commit 56774ea8da
Signed by: Euph Forge
GPG key ID: 85A06461FB6BDBB7
1 changed files with 20 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
Guides%2FDevelopment-Setup.md

@ -2,16 +2,17 @@
## Client
Um am Client zu arbeiten werden zwei dinge benötigt: [Redot Engine](https://www.redotengine.org/download) und [GDToolkit](https://github.com/Scony/godot-gdscript-toolkit/wiki/1.-Installation#godot-4).
Um am Client zu arbeiten werden zwei Dinge benötigt: [Redot Engine](https://www.redotengine.org/download) und [GDToolkit](https://github.com/Scony/godot-gdscript-toolkit/wiki/1.-Installation#godot-4).
Mit diesem Setup wird der Code automatisch beim Speichern formatiert, solange direkt in Redot gearbeitet wird.
### Linux
#### Redot Engine
1. Binary von https://www.redotengine.org/download/linux herunterladen
1. Entpacken und die ausführbare Datei nach `~/.local/bin/redot` tuhen
1. *(Optional)* Icon herunterladen von [hier](https://git.euph.dev/TowerDefence/Dokumentation/raw/branch/main/redot.svg) und nach `~/.icons/redot.svg` tuhen
1. `~/.local/share/applications/redot.desktop` anlegen mit folgenden content (username muss ausgetauscht werden):
1. Entpacken und die ausführbare Datei nach `~/.local/bin/redot` tun
1. *(Optional)* Icon herunterladen von [hier](https://git.euph.dev/TowerDefence/Dokumentation/raw/branch/main/redot.svg) und nach `~/.icons/redot.svg` tun
1. `~/.local/share/applications/redot.desktop` anlegen mit folgendem Content (username muss ausgetauscht werden):
```desktop
[Desktop Entry]
Name=Redot Engine
@ -51,8 +52,21 @@ Um am Client zu arbeiten werden zwei dinge benötigt: [Redot Engine](https://www
## Server
Der Server ist eine Springbootapplikation.
Es wird Gradle und Java benötigt. Beides wird direkt von [Jetbrain InteliJ](https://www.jetbrains.com/idea/) geliefert. Das Projekt liefert außerdem direkte Konfiguration für Intelij.
Es wird Gradle und Java benötigt. Beides wird direkt von [JetBrains IntelliJ](https://www.jetbrains.com/idea/) geliefert. Das Projekt liefert außerdem direkte Konfiguration für IntelliJ.
Es ist zusätzlich empfohlen, vor dem Committen alle Checks lokal auszuführen, dies kann entweder für jeden Check manuell mit Gradle gemacht werden, oder in IntelliJ direkt mit der `Check` Run-Konfiguration.
## Administration / Companion App
Die Administration und Companion App sind Angular Applikationen, dementsprechend ist Angular CLI benötigt. Zusätzlich wird auf [Volta](https://docs.volta.sh/reference/setup) für Node Management gesetzt, so wie auf [Just](https://just.systems/man/en/) für einfache Scripte gesetzt.
1. Installiere die drei oben genannten Tools
2. führe ein `npm i` aus, um alle node dependencies zu installieren
3. führe ein `just generate` aus, um den API Client zu generieren
4. führe ein `ng serve` aus, um das Projekt auszuführen
Es ist außerdem empfohlen, vor dem Committen das lokale Linting auszuführen, mit `just lint`.