README.md

@@ -0,0 +1,21 @@
+# WebGIS Citizen Participation Portal
+
+Citizen Participation Portal for Lohne (Oldenburg).
+
+## Project Structure
+
+- `migrations/` — versioned SQL Schema Migrations
+- `api/` — Backend (PHP)
+- `public/` — Frontend (HTML, CSS, JS)
+- `scripts/` — Maintenance Scripts (backup, deployment)
+- `legacy/` — Reference Code from Prototype
+
+## Local setup
+
+1. Copy `.env.example` to `.env` and fill in Database Credentials.
+2. Run the SQL Migration in pgAdmin and execute in the target database.
+3. Serve `public/` with a PHP-capable Web Server.
+
+## SSH tunnel to database server
+
+1. Create SSH Tunnel to Database Server.