From 5355da4f7266d60c3160f21fc8d89c8b02df4512 Mon Sep 17 00:00:00 2001
From: Thies Mueller <git@td00.de>
Date: Sat, 25 Apr 2026 23:09:35 +0200
Subject: [PATCH] add readme

---
 README.MD | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 70 insertions(+)
 create mode 100644 README.MD

diff --git a/README.MD b/README.MD
new file mode 100644
index 0000000..578dea8
--- /dev/null
+++ b/README.MD
@@ -0,0 +1,70 @@
+
+# Fotobox Web
+
+Webseite um Fotobox Bilder anzuzeigen & zu verwalten 
+
+
+## Features
+
+- Bilder anzeigen
+- Bilder löschen
+- Bilder teilen
+- Bilder herunterladen
+- Mietanfragen
+- Infos
+- Fotobox Orten
+
+
+## Setup
+
+Projekt Klonen
+
+```bash
+  git clone https://git.tservic.es/TMSS/fotobox-web
+```
+
+Projekt aufrufen
+
+```bash
+  cd fotobox-web
+```
+
+Abhängigkeiten installieren (composer)
+
+```bash
+  composer install
+```
+
+Config Dateien anpassen
+
+```bash
+  cp config.inc.php.example config.inc.php
+  vim config.inc.php
+```
+
+```bash
+    cp mailconfig.php.example mailconfig.php
+    vim mailconfig.php
+```
+
+```bash
+    cp location.json.example location.json
+    vim location.json
+```
+
+Bilder Ordner anlegen
+
+```bash
+    mkdir images
+```
+
+
+
+
+## Hinweise
+
+- Die Seite erwartet, dass die Bilder die Endung ".jpg" hat und der Dateiname 32 Zeichen Alpha Numerisch ist.
+- "Löschen" löscht die Bilder nicht direkt sondern nennt sie in deleted_<name> um. Das löschen muss extern geregelt sein.
+- Die Bilder müssen in dem Ordner /pfad/zum/projekt/fotobox-web/images/ abgelegt werden und die lese & schreib berechtigungen für den Web Prozess müssen vorhanden sein
+- An vielen Stellen ist RegattaTech.de / Thies Mueller Service Solutions hardcoded!
+- Die Software wird zusammen mit [PhotoboothProject](https://github.com/PhotoboothProject/photobooth) genutzt.
\ No newline at end of file