Designsystem und Seitenlandkarte dokumentiert (#11)
docs/design/README.md: Tokens hell/dunkel aus globals.css, Bausteine aus ui.tsx, verbindliche Zustände (Laden, leer, Fehler, offline, veraltet, gesperrt, Betriebsalarm), WCAG-2.2-AA-Regeln mit Verweis auf die automatische axe-/Tastatur-/360-px-Prüfung (apps/e2e). docs/design/sitemap.md: alle Seiten (öffentlich, Kunde, Personal), mobile Navigation, fünf Kernabläufe. FlessingLabs-Stil, keine alte Palette. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
parent
7f6c60ba95
commit
dc54295f9d
2 changed files with 96 additions and 0 deletions
54
docs/design/README.md
Normal file
54
docs/design/README.md
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
# Designsystem und Seitenstruktur
|
||||
|
||||
Stand: 06.10.2026. Quelle der Wahrheit ist der Code: Tokens in `apps/web/src/app/globals.css`, Bausteine in `apps/web/src/components/ui.tsx`, Icons in `components/Icon.tsx` (Lucide-Pfade, keine Emojis). Stil „FlessingLabs“ (an flessinglabs.com angelehnt, live seit #121–#127) – die frühere Calm-Cloud/KeyControl-Palette ist abgelöst und wird nicht wiederhergestellt.
|
||||
|
||||
- `sitemap.md` – Seitenlandkarte (öffentlich, Kunde, Personal) und Kernabläufe
|
||||
- Dieses Dokument – Tokens, Komponenten, Zustände, Barrierefreiheit
|
||||
|
||||
## Tokens (CSS-Variablen)
|
||||
|
||||
| Gruppe | Hell | Dunkel | Verwendung |
|
||||
|---|---|---|---|
|
||||
| Hintergrund/Fläche | `--bg #f5f7fb`, `--surface #fff`, `--surface-2 #eef1f7` | `#05060a`, `#0b0d14`, `#121622` | Seite, Karten, abgesetzte Flächen |
|
||||
| Text | `--text #111522`, `--muted #5b6475` | `#f5f7ff`, `#9aa4b5` | Fließtext, Nebeninfo (≥ 4,5:1 auf Fläche) |
|
||||
| Akzent | `--accent #1a5fd0`, `--accent2 #0a7ea8`, `--focus #1a5fd0` | `#4d9dff`, `#20d4f5`, `#20d4f5` | Links, primäre Aktionen, Fokusring |
|
||||
| Rahmen | `--border #e3e7ef`, `--border-strong #7a8599` | `rgba(255,255,255,.08)`, `#5f6b7c` | Trennlinien; **Eingabefelder immer `--border-strong`** (3:1 für UI-Komponenten) |
|
||||
| Status | `--ok/-bg`, `--info/-bg`, `--warn/-bg`, `--err/-bg`, `--lock/-bg` | dunkle Varianten | Badges, Hinweise; nie nur Farbe – immer Symbol + Text |
|
||||
| Navigation | `--nav-bg #0b0d14` … | `#05060a` … | dunkle Seitenleiste in beiden Modi |
|
||||
| Marke | `--brand-gradient` (#20d4f5 → #2584ff → #7028ff), `--brand-btn` | gleich | Logo, primärer Knopf |
|
||||
| Form | `--radius 12px`, `--radius-lg 16px`, `--radius-sm 10px` | | |
|
||||
| Abstände | `--s1 4`, `--s2 8`, `--s3 16`, `--s4 24`, `--s5 40` px | | |
|
||||
| Schrift | Geist / Geist Mono (`next/font`), Fallback system-ui | | |
|
||||
|
||||
Hell/Dunkel folgt `prefers-color-scheme`; die manuelle Wahl (ThemeToggle) setzt `data-theme` und wird gemerkt.
|
||||
|
||||
## Bausteine (`components/ui.tsx`)
|
||||
|
||||
- `Alert kind=err|warn|ok|info` – Meldungen; `err` mit `role="alert"`, sonst `role="status"`.
|
||||
- `Field id label hint` – Label immer sichtbar und verknüpft, Hinweis per `aria-describedby`.
|
||||
- `Empty title` – Leerzustand mit Erklärung, was zu tun ist.
|
||||
- Status-Badges (`Status`, `ResState`, `JobStatus`, `OrderStatusBadge`, `ContractStatusBadge`, `InvoiceStatusBadge`, `TicketStatusBadge`) – Symbol (`aria-hidden`) + Klartext.
|
||||
- `TableCards` – Tabellen werden unter 720 px automatisch zu Karten (Spaltenkopf als Label).
|
||||
- `SecretField` – Geheimnisse nur auf ausdrücklichen Abruf, Kopieren ohne Anzeige.
|
||||
- Formatierer: `fmt` (Datum+Zeit), `fmtDate`, `fmtDay` (Kalendertag in UTC), `eur` (Cent → Euro).
|
||||
|
||||
## Zustände (Pflicht für jede Seite mit Daten)
|
||||
|
||||
| Zustand | Vorgabe | Beispiel |
|
||||
|---|---|---|
|
||||
| Laden | Text „Wird geladen …“ mit `role="status"` (kein reiner Spinner) | Rechnungen → Fällig |
|
||||
| Leer | `Empty` mit Titel und nächstem Schritt | „Keine fälligen Perioden“ |
|
||||
| Fehler | `Alert kind="err"` mit der Meldung der API (`errMsg`), Formularwerte bleiben erhalten | alle Formulare |
|
||||
| Offline / Server nicht erreichbar | `errMsg` liefert „Der Server ist nicht erreichbar. Bitte später erneut versuchen.“ | API-Client |
|
||||
| Teilfehler / veraltet | `Alert kind="warn"` + Badge „Veraltet“, es wird der zuletzt bekannte Stand gezeigt | Ressourcen (Anbieter nicht erreichbar) |
|
||||
| Gesperrt / Lizenz nötig | Badge `lock` bzw. Hinweis „nur mit Lizenz“ mit Link zu Einstellungen → Lizenz | Testmodus-Hinweisleiste |
|
||||
| Betriebsalarm | Karte „Betriebsalarme“ im Dashboard (`role="alert"`) | #38 |
|
||||
|
||||
## Barrierefreiheit (WCAG 2.2 AA)
|
||||
|
||||
- Kontrast Text ≥ 4,5:1, UI-Komponenten ≥ 3:1 (Eingaben mit `--border-strong`); geprüft automatisch per axe in `apps/e2e` (Login, Dashboard, Kundenliste, Kunden-Dashboard; hell/Desktop und dunkel/360 px).
|
||||
- Tastatur: sichtbarer Fokus (`--focus`), logische Reihenfolge, `autoFocus` nur auf dem ersten Feld eines Formulars, Enter sendet. E2E prüft Fokus/Tab/Enter auf der Anmeldung.
|
||||
- Mobil: Mindestgröße für Bedienelemente 44 px (untere Navigation 56 px), Navigation unten mit „Mehr“-Menü; kein horizontales Scrollen bei 360 px.
|
||||
- Bewegung: keine automatischen Animationen mit Bedeutung; Statusänderungen als Text.
|
||||
|
||||
Automatische Prüfung: `ops/test/run-e2e.sh` (CI-Job `e2e`, #39). Neue Seiten in `apps/e2e/tests` aufnehmen.
|
||||
42
docs/design/sitemap.md
Normal file
42
docs/design/sitemap.md
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
# Seitenlandkarte und Kernabläufe
|
||||
|
||||
Stand: 06.10.2026, aus `apps/web/src/app` (alle `page.tsx`). Sichtbarkeit richtet sich nach den Rechten aus `/auth/me`; durchgesetzt wird in der API (`docs/sicherheit-und-bedrohungsmodell.md`).
|
||||
|
||||
## Öffentlich (ohne Anmeldung)
|
||||
- `/login` – Anmeldung, zweiter Schritt 2FA
|
||||
- `/passwort-vergessen`, `/passwort-reset` – Selbstbedienung per E-Mail-Link
|
||||
- `/einladung` – Einladung annehmen, Passwort festlegen
|
||||
- `/vertrag-entscheidung` – „Vertrag behalten / kündigen“ aus der Erinnerungsmail (Einmal-Link)
|
||||
|
||||
## Kunde
|
||||
| Bereich | Seiten |
|
||||
|---|---|
|
||||
| Übersicht | `/dashboard` (Kurzlisten: Hosting und Lizenzen, Tickets, Rechnungen) |
|
||||
| Produkte | `/lizenzen`, `/lizenzen/[id]`, `/ressourcen`, `/ressourcen/[id]` (Panel-Login, freigegebene Aktionen), `/vertraege`, `/vertraege/[id]` (Kündigung), `/bestellungen`, `/bestellen` |
|
||||
| Abrechnung | `/rechnungen`, `/rechnungen/[id]` (PDF) |
|
||||
| Support | `/tickets`, `/tickets/[id]` (Anhänge) |
|
||||
| Organisation | `/organisation` (Mitglieder einladen – owner/admin) |
|
||||
| Werkzeuge | `/domains` (Domain prüfen) |
|
||||
| Konto | `/konto` (Passwort, 2FA, Sitzungen, Discord verknüpfen) |
|
||||
|
||||
## Personal (zusätzlich, je nach Rolle)
|
||||
| Bereich | Seiten |
|
||||
|---|---|
|
||||
| Kunden | `/admin/kunden`, `/admin/kunden/[id]` (Als Kunde ansehen), `/admin/kunden/uebernahme` |
|
||||
| Produkte | `/admin/produkte`, `/admin/produkte/[id]`, `/admin/produkte/hosting-tarif`, `/admin/produkte/domains`, `/admin/produkte/uebernahme`, `/lizenzen/neu` |
|
||||
| Domains | `/admin/domains` (Aufstellung EK/VK, CSV) |
|
||||
| Abrechnung | `/rechnungen/faellig` (Mahnüberblick, Abrechnungslauf), `/rechnungen/export` (DATEV/CSV/PDF-ZIP) |
|
||||
| Support | `/admin/posteingang` (IMAP-Mails zuordnen) |
|
||||
| Verwaltung | `/admin/benutzer`, `/admin/auftraege`, `/admin/audit` |
|
||||
| Einstellungen | `/einstellungen` → `firma`, `lizenz`, `email` (SMTP/IMAP/Vorlagen), `discord`, `backup`, `verbindungen` |
|
||||
|
||||
Mobil (< 720 px): untere Navigation Übersicht · Ressourcen · Tickets · Rechnungen · Mehr (öffnet die volle Navigation inkl. Konto/Abmelden).
|
||||
|
||||
## Kernabläufe
|
||||
1. **Kunde anlegen → Einladung → erste Anmeldung:** Personal `/admin/kunden` → „Kunde anlegen“ → Mail/Link → `/einladung` → `/login` → `/dashboard`. (E2E: `apps/e2e`)
|
||||
2. **Bestellung → Freigabe → Bereitstellung → Vertrag:** Kunde `/bestellen` → Personal gibt frei → Auftrag im Worker → Ressource/Lizenz + Vertrag aktiv → Kunde sieht `/ressourcen`, `/vertraege`.
|
||||
3. **Rechnung:** Abrechnungslauf oder Entwurf von Hand → prüfen → „Ausstellen“ → Mail mit Link → Kunde `/rechnungen/[id]` (PDF) → „Als bezahlt markieren“ / „Stornieren“.
|
||||
4. **Ticket:** Kunde `/tickets` (Web), Discord `/ticket` oder Antwort auf Ticket-Mail → Personal antwortet (Web/Discord) → Mail an Kunden → schließen.
|
||||
5. **Kündigung:** Erinnerung 30 Tage vor Laufzeitende → `/vertrag-entscheidung` oder `/vertraege/[id]` → wirksam zum Laufzeitende (Vertragslauf).
|
||||
|
||||
Wireframes: Die umgesetzten Seiten sind die Referenz (Screenshots der Kernseiten entstehen bei jedem E2E-Lauf im Fehlerfall als Trace; die Galerie auf flessinglabs.com zeigt Demo-Ansichten). Eigene Wireframe-Dateien werden nicht separat gepflegt, um Abweichungen vom Code zu vermeiden.
|
||||
Loading…
Add table
Add a link
Reference in a new issue