Update Readme
This commit is contained in:
parent
ff0e2b9890
commit
42cfaed2f9
1 changed files with 5 additions and 5 deletions
10
README.md
10
README.md
|
|
@ -24,11 +24,11 @@
|
||||||
|
|
||||||
## Motivation / Problemstellung
|
## Motivation / Problemstellung
|
||||||
|
|
||||||
Die Einrichtung adäquater Entwicklungsumgebungen stellt besonders in der Lehre eine signifikante Hürde dar. Studierende nutzen oft heterogene Systeme (Betriebssysteme, installierte Software, Konfigurationen) [source: 9], was häufig zu Kompatibilitätsproblemen, zeitaufwendiger Fehlersuche und dem bekannten „Works on my machine“-Problem führt. Dies verursacht Frustration, erhöht den Betreuungsaufwand und lenkt vom eigentlichen Lerninhalt ab. Besonders bei komplexen Technologie-Stacks, wie sie in der Webentwicklung mit Java (z.B. Jakarta EE, Spring Boot, Datenbanken) üblich sind, ist die manuelle Konfiguration fehleranfällig.
|
Die Einrichtung adäquater Entwicklungsumgebungen stellt besonders in der Lehre eine signifikante Hürde dar. Studierende nutzen oft heterogene Systeme (Betriebssysteme, installierte Software, Konfigurationen), was häufig zu Kompatibilitätsproblemen, zeitaufwendiger Fehlersuche und dem bekannten „Works on my machine“-Problem führt. Dies verursacht Frustration, erhöht den Betreuungsaufwand und lenkt vom eigentlichen Lerninhalt ab. Besonders bei komplexen Technologie-Stacks, wie sie in der Webentwicklung mit Java (z.B. Jakarta EE, Spring Boot, Datenbanken) üblich sind, ist die manuelle Konfiguration fehleranfällig.
|
||||||
|
|
||||||
## Lösungsansatz
|
## Lösungsansatz
|
||||||
|
|
||||||
Dieses Projekt bietet eine plattformübergreifende Desktop-Anwendung (`jws-Executable`), die den Prozess der Bereitstellung standardisierter Entwicklungsumgebungen für universitäre Java-Webprojekte radikal vereinfacht. Unter Nutzung von **Docker** für die Containerisierung und dem **Dev Container Standard** ermöglicht das Tool Studierenden, mit wenigen Klicks eine vorkonfigurierte, lauffähige und konsistente Umgebung für spezifische Projektvorlagen zu initialisieren.
|
Dieses Projekt bietet eine plattformübergreifende Desktop-Anwendung (`jws`), die den Prozess der Bereitstellung standardisierter Entwicklungsumgebungen für universitäre Java-Webprojekte radikal vereinfacht. Unter Nutzung von **Docker** für die Containerisierung und dem **Dev Container Standard** ermöglicht das Tool Studierenden, mit wenigen Klicks eine vorkonfigurierte, lauffähige und konsistente Umgebung für spezifische Projektvorlagen zu initialisieren.
|
||||||
|
|
||||||
Das Tool wurde in **Go** mit dem **Fyne** GUI-Toolkit entwickelt, um native Ausführbarkeit unter Windows, macOS und Linux zu gewährleisten
|
Das Tool wurde in **Go** mit dem **Fyne** GUI-Toolkit entwickelt, um native Ausführbarkeit unter Windows, macOS und Linux zu gewährleisten
|
||||||
|
|
||||||
|
|
@ -97,7 +97,7 @@ Die einfachste Methode ist das Herunterladen einer vorkompilierten Version für
|
||||||
|
|
||||||
## Benutzung
|
## Benutzung
|
||||||
|
|
||||||
1. **Starten Sie die Anwendung** (`jws-Executable`). Ein Info-Fenster weist auf wichtige Punkte hin.
|
1. **Starten Sie die Anwendung** (`jws`). Ein Info-Fenster weist auf wichtige Punkte hin.
|
||||||
2. **Abhängigkeits-Check:** Die Anwendung prüft, ob Docker Desktop und Visual Studio Code installiert sind ("Dependency Screen").
|
2. **Abhängigkeits-Check:** Die Anwendung prüft, ob Docker Desktop und Visual Studio Code installiert sind ("Dependency Screen").
|
||||||
- Falls etwas fehlt, klicken Sie auf die entsprechenden Buttons, um die Installation anzustoßen. Folgen Sie den Anweisungen (ggf. sind Admin-Rechte nötig). Ein Fortschrittsbalken wird angezeigt.
|
- Falls etwas fehlt, klicken Sie auf die entsprechenden Buttons, um die Installation anzustoßen. Folgen Sie den Anweisungen (ggf. sind Admin-Rechte nötig). Ein Fortschrittsbalken wird angezeigt.
|
||||||
3. **Template-Auswahl:** Sobald alle Abhängigkeiten erfüllt sind, gelangen Sie zum "Project Screen". Wählen Sie hier das gewünschte Projekt-Template aus (z.B. "JakartaEE Todo-App mit JSP").
|
3. **Template-Auswahl:** Sobald alle Abhängigkeiten erfüllt sind, gelangen Sie zum "Project Screen". Wählen Sie hier das gewünschte Projekt-Template aus (z.B. "JakartaEE Todo-App mit JSP").
|
||||||
|
|
@ -105,7 +105,7 @@ Die einfachste Methode ist das Herunterladen einer vorkompilierten Version für
|
||||||
5. **Öffnen in VS Code:** Die Anwendung öffnet das erstellte Projektverzeichnis automatisch in Visual Studio Code.
|
5. **Öffnen in VS Code:** Die Anwendung öffnet das erstellte Projektverzeichnis automatisch in Visual Studio Code.
|
||||||
6. **In Container öffnen:**
|
6. **In Container öffnen:**
|
||||||
- Stellen Sie sicher, dass Docker Desktop läuft.
|
- Stellen Sie sicher, dass Docker Desktop läuft.
|
||||||
- VS Code sollte eine Benachrichtigung anzeigen: "Folder contains a Dev Container configuration file. Reopen folder to develop in a container?" [source: 221]. Klicken Sie auf "**Reopen in Container**".
|
- VS Code sollte eine Benachrichtigung anzeigen: "Folder contains a Dev Container configuration file. Reopen folder to develop in a container?". Klicken Sie auf "**Reopen in Container**".
|
||||||
- (Falls die Benachrichtigung nicht erscheint: Klicken Sie auf das blaue Icon `><` unten links in der VS Code Statusleiste oder nutzen Sie die Befehlspalette (Ctrl+Shift+P) und suchen Sie nach "Dev Containers: Reopen in Container".
|
- (Falls die Benachrichtigung nicht erscheint: Klicken Sie auf das blaue Icon `><` unten links in der VS Code Statusleiste oder nutzen Sie die Befehlspalette (Ctrl+Shift+P) und suchen Sie nach "Dev Containers: Reopen in Container".
|
||||||
7. **Build & Run:** Docker/VS Code bauen nun das Image und starten die Container (dies kann beim ersten Mal etwas dauern). Sobald die Umgebung bereit ist, können Sie im integrierten Terminal von VS Code arbeiten, als wären Sie direkt im Container.
|
7. **Build & Run:** Docker/VS Code bauen nun das Image und starten die Container (dies kann beim ersten Mal etwas dauern). Sobald die Umgebung bereit ist, können Sie im integrierten Terminal von VS Code arbeiten, als wären Sie direkt im Container.
|
||||||
- **Beispiel (für JakartaEE JSP Template):** Führen Sie im VS Code Terminal aus:
|
- **Beispiel (für JakartaEE JSP Template):** Führen Sie im VS Code Terminal aus:
|
||||||
|
|
@ -146,7 +146,7 @@ Dies stellt sicher, dass alle Nutzer exakt die gleiche Umgebung mit den richtige
|
||||||
- **SELinux (Fedora):** Unter Fedora mit aktiviertem SELinux kann es zu Problemen beim Mounten von Host-Verzeichnissen in Docker-Containern kommen. Ein Workaround ist `sudo setenforce 0` (nicht empfohlen), eine korrekte SELinux-Konfiguration für Docker ist komplexer.
|
- **SELinux (Fedora):** Unter Fedora mit aktiviertem SELinux kann es zu Problemen beim Mounten von Host-Verzeichnissen in Docker-Containern kommen. Ein Workaround ist `sudo setenforce 0` (nicht empfohlen), eine korrekte SELinux-Konfiguration für Docker ist komplexer.
|
||||||
- **Abhängigkeit von Paketmanagern:** Die automatische Installation hängt vom Funktionieren externer Tools wie Winget und Homebrew ab. Fehler in diesen Tools können die Installation behindern.
|
- **Abhängigkeit von Paketmanagern:** Die automatische Installation hängt vom Funktionieren externer Tools wie Winget und Homebrew ab. Fehler in diesen Tools können die Installation behindern.
|
||||||
- **Manuelle Schritte:** Docker Desktop muss manuell gestartet werden, bevor "Reopen in Container" funktioniert
|
- **Manuelle Schritte:** Docker Desktop muss manuell gestartet werden, bevor "Reopen in Container" funktioniert
|
||||||
- **Installation Robustheit:** Obwohl auf mehreren Systemen getestet [source: 235], kann es auf spezifischen Konfigurationen zu Problemen kommen
|
- **Installation Robustheit:** Obwohl auf mehreren Systemen getestet, kann es auf spezifischen Konfigurationen zu Problemen kommen
|
||||||
- **Evaluation:** Bisher hauptsächlich technisch und durch Experten-Feedback evaluiert. Eine breite Evaluation mit Studierenden (Usability, Zeitersparnis) steht noch aus
|
- **Evaluation:** Bisher hauptsächlich technisch und durch Experten-Feedback evaluiert. Eine breite Evaluation mit Studierenden (Usability, Zeitersparnis) steht noch aus
|
||||||
|
|
||||||
## Zukünftige Arbeit / Ausblick
|
## Zukünftige Arbeit / Ausblick
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue