werkstaetten-app/README.md
Friederich Loheide bef8574e07 Werkstatt-App: öffentliche PWA und Redaktions-Backend
Werbefreie, barrierearme Info-App für Werkstätten (WfbM) auf Basis von
SvelteKit, Tailwind, SQLite/Drizzle:

- App: Startseite mit Kacheln, Meldungen, Seitenbaum, Termine inkl.
  Schließzeiten und iCal-Abo, Ansprechpartner, Suche, Kontaktformular,
  Merkliste, Vorlesen, Leichte Sprache, Schriftgrößen, Hell/Dunkel, PWA
- Redaktion: Dashboard, Meldungen, Seiten, Termine, Kacheln,
  Ansprechpartner, Mediathek mit Bildoptimierung, Postfach, Benutzer
  mit Rollen, Einstellungen (Name, Logo, Farbe, Rechtstexte)
- Demo-Seed, CLI zum Anlegen von Benutzern, Dockerfile und Compose

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
2026-09-29 20:55:13 +00:00

77 lines
3.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Werkstatt-App
Eine moderne, werbefreie Info-App für Werkstätten für Menschen mit Behinderung (WfbM) –
mit einfachem Redaktions-Backend. Läuft als installierbare Web-App (PWA) auf Handy,
Tablet und Desktop.
## Funktionen
**App (öffentlich)**
- Startseite mit Begrüßung, Suche, frei konfigurierbaren Kacheln, Neuigkeiten und nächsten Terminen
- Meldungen mit Titelbild, Galerie, Video (datensparsam erst nach Klick), Dateien und Ansprechpartnern
- Infoseiten in beliebiger Tiefe (z. B. „Dienste → Sozialer Dienst“)
- Termine & Schließzeiten, gruppiert nach Monat, mit Kalender-Abo (`/termine.ics`)
- Ansprechpartner-Verzeichnis, Kontaktformular, Volltextsuche
- **Barrierearm:** gut lesbare Schrift (Atkinson Hyperlegible), 3 Schriftgrößen, Hell/Dunkel,
**Vorlesen**-Funktion, **Leichte Sprache** pro Seite/Meldung
- Merkliste (lokal auf dem Gerät), Teilen, offline lesbar, als App installierbar
- Keine Werbung, kein Tracking, keine externen Schriften oder CDNs
**Redaktion (`/admin`)**
- Übersicht, Meldungen (Entwurf, geplante Veröffentlichung, anheften), Seitenbaum, Termine,
Startseiten-Kacheln, Ansprechpartner, Mediathek, Postfach
- Text-Editor mit Formatierungen, Links und Bildern
- Bilder werden automatisch gedreht, verkleinert und als WebP gespeichert
- Rollen: **Redakteur** (Inhalte) und **Administrator** (zusätzlich Benutzer & Einstellungen)
- Einstellungen: App-Name, Logo, Markenfarbe, Texte, Impressum, Datenschutz – das App-Symbol
wird daraus automatisch erzeugt
## Technik
SvelteKit 2 (Svelte 5) · Tailwind CSS 4 · SQLite (better-sqlite3) mit Drizzle ORM · sharp · Tiptap.
Bewusst schlank: ein Node-Prozess, eine SQLite-Datei, ein Upload-Ordner (~200 MB RAM im Betrieb).
## Loslegen (Entwicklung)
```bash
npm install
npm run db:seed # Demo-Inhalte (fiktive „Lindenhof Werkstätten“)
npm run user:create -- admin@example.org ein-langes-passwort admin "Vorname Name"
npm run dev
```
App: http://localhost:5173 · Redaktion: http://localhost:5173/admin
## Betrieb
```bash
cp .env.example .env # ORIGIN, ADMIN_EMAIL, ADMIN_PASSWORD setzen
docker compose up -d --build
```
Alle Daten (Datenbank + Uploads) liegen in `./data` – das ist das Einzige, was gesichert werden muss.
Der Container lauscht auf `127.0.0.1:3000`; davor einen Reverse-Proxy mit HTTPS (z. B. Caddy) setzen.
Ohne Docker: `npm ci && npm run build && ORIGIN=https://… BODY_SIZE_LIMIT=30M node build`.
| Variable | Bedeutung |
| --------------------------------- | --------------------------------------------------------------- |
| `ORIGIN` | Öffentliche URL (Pflicht in Produktion, sonst schlagen Formulare fehl) |
| `DATA_DIR` | Ordner für `app.db` und `uploads/` (Standard `./data`) |
| `ADMIN_EMAIL` / `ADMIN_PASSWORD` | Erster Admin, wird angelegt, solange es noch keinen Benutzer gibt |
| `BODY_SIZE_LIMIT` | Max. Upload-Größe (im Docker-Image auf 30M gesetzt) |
## Erweitern
- **Neues Feld / neuer Inhaltstyp:** `src/lib/server/db/schema.ts` ändern → `npm run db:generate`
erzeugt eine Migration in `drizzle/`, die beim nächsten Start automatisch eingespielt wird.
- **Admin-Bereiche** folgen alle demselben Muster: `src/routes/admin/(panel)/<bereich>/`
mit Liste (`+page`) und Bearbeiten (`[id]/+page`, `neu` = anlegen). Bausteine liegen in `src/lib/admin/`.
- **Icons** für Kacheln/Seiten: `src/lib/icons.ts`, **Farben**: `src/lib/palette.ts` + `.tone-*` in `src/app.css`.
- **Öffentliche Seiten:** `src/routes/(app)/`, Datenabfragen gebündelt in `src/lib/server/content.ts`.
## Ideen für später
Push-Benachrichtigungen (Web Push), E-Mail-Weiterleitung des Kontaktformulars, Umfragen,
Mehrsprachigkeit, Standort-Filter für Speisepläne.