From 364db2206b8542ee02b30c73e02f885e9f2ed9e7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Christian=20Fra=C3=9F?=
 <christian.frass@dielinke-glauchau.de>
Date: Mon, 22 Apr 2024 10:20:01 +0200
Subject: [PATCH] [mod] readme

---
 readme.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/readme.md b/readme.md
index e69de29..cc24405 100644
--- a/readme.md
+++ b/readme.md
@@ -0,0 +1,36 @@
+# Espe | Frontend
+
+## Beschreibung
+
+- Web-Anwendung für Espe ("Erweiterte Sächsische Partei-Eingliederung")
+
+
+## Erstellung
+
+### Voraussetzungen
+
+- GNU Make
+- Typescript Compiler
+
+
+### Anweisungen
+
+- `tools/build` ausführen
+
+
+## Betrieb
+
+### Voraussetzungen
+
+- wahlweise einen Python-Interpreter oder ein vollwertiger Web-Server (nginx, Apache, lighttpd, …)
+
+
+- halbwegs aktueller Web-Browser
+
+
+### Anweisungen
+
+- `conf.json` im build-Verzeichnis anlegen
+- für Entwicklung und Test kann der Python-Webserver genutzt werden: `tools/run [port]`
+- für Produktiv-Umgebungen sollte eine vhost-Konfiguration für den Web-Server angelegt werden
+