Zum Inhalt

Übersicht

Repository

Repository Issues

Allgemeine Informationen

Das Behörden-KlarText Frontend wurde als Prototyp entwickelt, um schnell und unkompliziert Feedback zur Qualität der generierten Texte von Nutzenden einzuholen. Der Aufbau ähnelt dem Word Add-In. Sie können Text eingeben und optimieren. Nach der Optimierung können Sie Feedback zur Textqualität geben. Für die Entwicklung dieses Frontends wird vue genutzt.

Konfiguration

Ist momentan noch nicht verfügbar. Wird mit der Anpassung von nginx befüllt.

Bauen

Beim Deployment mit Containern ist zu beachten, dass nginx das Backend bei backend:8000 erwartet.

  • Passen Sie FRONTEND_PORT=54322 in der .env-Datei an.

  • Setzen Sie die Backend-URL in der .env-Datei auf VUE_APP_BACKEND_URL="". Diese ist nur für die Entwicklung relevant.

  • Docker Netzwerk erzeugen, falls nicht vorhanden:

docker network create behoerden_klartext_net

  1. Backend im gleichen Netzwerk starten.

  2. Danach Frontend Container starten:

docker compose build
docker compose up

Danach sollte das Frontend unter http://localhost:54322 erreichbar sein.

pre-commit

Für einen einheitlichen Coding Style nutzen wir pre-commit Checks. Bitte installieren Sie pre-commit in der Python-Umgebung, von der aus Sie die Commits durchführen.

  1. Python-Umgebung mit der aktuell genutzen Python-Version aufsetzen (siehe Dockerfile, z. B. 3.12.10) und aktivieren.

  2. requirements-dev.txt installieren:

    pip install -r requirements-dev.txt

  3. pre-commit initialisieren:

    pre-commit install

  4. Initialer Run. Es werden ggf. Dateien formatiert:

    pre-commit run --all-files

  5. Commits wie üblich durchführen. pre-commit läuft automatisch und gibt Feedback für notwendige Änderungen. Formatierungen werden ggf. direkt ausgeführt und Dateien damit geändert.

Erst wenn alle pre-commit Checks "passed" sind, kann committed werden.

Wenn pre-commit nicht lokal läuft, werden Formatierungsfehler spätestens durch die CI gefunden und Merges Blockiert. Lokales Ausführen von pre-commit zeigt direkt betroffene Code-Stellen, führt einfache Fixes automatisch durch und erleichtert ggf. Nacharbeiten.

Entwicklung

Um die Entwicklung zu erleichtern, können Sie das Frontend lokal, außerhalb des Containers testen und entwickeln.

  • Passen Sie den FRONTEND_PORT=54322 in der .env-Datei an.
  • Setzen Sie die Backend-URL in der .env-Datei: VUE_APP_BACKEND_URL="<deine-backend-url>".

Das Frontend kompiliert und lädt bei Änderungen automatisch neu (Hot-Reload) für die Entwicklung:

npm run serve

Tests

Im Moment gibt es noch keine Tests für das Frontend.

Roadmap

  • Anpassung der UI an den aktuellen Stand des Word-Add-Ins.