[mod] readme

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
+