From fd4cf55fb29582ec7892ef3ecb3604b3960516b9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lucas=20Ple=C3=9F?= <lpless@theaterdo.de>
Date: Tue, 21 Jan 2025 13:00:10 +0100
Subject: [PATCH] added readme

---
 README.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..74ed5bc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,60 @@
+# Zammad Form
+
+Dieses VUE 3 und Python Flask Projekt stellt ein kleines Formular zur Verfügung. Mit diesem Formular können Menschen ohne einen Zugang zu Zammad Tickets erstellen.
+
+Das Projekt enthält ein Dockerfile und eine docker-compose config mit der man den Container erstellen kann.
+
+# Entwicklungsumgebung
+
+Zum entwickeln benötigt man Python (>3.8) und nodejs auf dem System.
+Den Vue Js Dev Server startet man wie folgt:
+
+    cd frontend
+    npm install (das nur einmalig nötig)
+    npm run dev
+
+Um den Backend Server zu starten, braucht es die beiden Environment Vars ZAMMAD_URL und ZAMMAD_TOKEN. Diese konfiguriert man entweder im System oder per VS Code launch.json Datei
+
+Manuell starten mit auto reload:
+
+    cd backend
+    python app.py
+
+oder mit VS code launch.json:
+
+    {
+        "version": "0.2.0",
+        "configurations": [
+            {
+                "name": "Python Debugger: Flask",
+                "type": "debugpy",
+                "request": "launch",
+                "module": "flask",
+                "env": {
+                    "FLASK_APP": "backend\\app.py",
+                    "FLASK_DEBUG": "1",
+                    "FLASK_RUN_PORT": "8080",
+                    "ZAMMAD_URL": "https://tickets.XXXXX.net/api/v1/",
+                    "ZAMMAD_TOKEN": "XXXXX"
+                },
+                "args": [
+                    "run",
+                    "--no-debugger",
+                    "--no-reload"
+                ],
+                "jinja": true,
+                "autoStartBrowser": false
+            }
+        ]
+    }
+
+# Docker Compose
+
+Container bauen:
+
+    docker compose build
+
+
+Container laufen lassen:
+
+    docker compose run (-d)
\ No newline at end of file