Files
HiveGrid-Wireframes/03 Quellen und Referenzen/hivegrid-cloud/docs/ops/local-demo-seed.md
T

84 lines
3.7 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.
# Lokaler Demo-Seed (HiveGrid SHK)
Befüllt einen reichhaltigen, realistischen SHK/Handwerk-Demo-Tenant zum lokalen
Erkunden der App. Nach dem Seed ist der Workspace voll bestückt (Kontakte,
Pipelines, Projekte, Leads, Forms, Bookings, Kalender, Automationen, Tasks,
Rechnungen, Activities, Benachrichtigungen, API-Key, eingehender Webhook) statt
leer.
Quelle: `scripts/seed-hivegrid-demo.ts` (Muster: `scripts/seed-e2e-readiness.ts`).
## Ausführen
```bash
pnpm seed:demo
```
Das Skript setzt das Guard-Flag `HIVEGRID_DEMO_SEED=1` selbst. Es läuft **nie in
Produktion** (`NODE_ENV=production` → Abbruch) und braucht ein erreichbares
`DATABASE_URL`. Der Seed ist **idempotent**: mehrfaches Ausführen aktualisiert die
Daten in-place, es entstehen keine Duplikate (deterministische `demo-*`-IDs bzw.
`@@unique`-Upserts). Alle Fachdaten tragen `isDemoData = true`, sofern die jeweilige Tabelle dieses Feld unterstützt.
## Login-Daten
Alle Nutzer haben das Passwort `password`.
| E-Mail | Rolle im Betrieb | Tenant-Rolle | App-Rolle(n) |
|---|---|---|---|
| `demo@hivegrid.de` | Geschäftsführer | Owner | SuperUser (voll berechtigt) |
| `buero@hivegrid.de` | Büro/Verwaltung | Admin | Admin, Billing Admin |
| `monteur@hivegrid.de` | Monteur | Member | User |
| `vertrieb@hivegrid.de` | Vertrieb | Member | User |
Login-URL: `http://localhost:3000/hivegrid-demo/dashboard`
Tenant: Slug `hivegrid-demo`, Name `HiveGrid Demo SHK`, Blueprint `crm-saas`,
aktive Business-Subscription, die wichtigsten v1-Feature-Gates freigeschaltet
(`dashboard`, CRM, Leads, Projekte, Tasks, Files, HR, Integrationen, Bookings,
Forms, Automationen, E-Mail-Inbox, API, Suche).
## Was wird geseedet
- **14 Kontakte:** 6 Firmen (mit Adresse) + 8 Privatpersonen (mit E-Mail + Telefon)
- **3 Pipelines** mit Stages (Vertriebs- und Auftrags-Pipeline)
- **8 Projekte** über mehrere Stages verteilt (inkl. gewonnen/verloren)
- **6 Leads** (verschiedene Quellen + Status) mit 3 Lead-Sources
- **5 Forms** (u.a. `SHK Angebotsanfrage`, `SHK Abnahmeprotokoll`) mit
**9 Submissions** und Action-Logs
- **2 Booking-Pages** mit **3 Terminen**, Provider-Zuordnung, Verfügbarkeits-Regeln
(Mo–Fr für 3 Nutzer) plus **4 Datums-Ausnahmen** (Urlaub + Custom-Window, für den
`/availability`-Editor); die Seite `Beratung vor Ort` ist mit dem Intake-Form
`SHK Angebotsanfrage` verknüpft (AK-P16b/AK-P16c)
- **6 Kalender-Events** inkl. Booking-Spiegelung, externem Privat-Termin und einer
zweitägigen ganztägigen Messe (Quell-Marker fürs Kalender-Grid) + 1 Konflikt-Log-Eintrag
- **2 Automationen** mit **4 Executions** inkl. Erfolg, Dry-Run und Fehlerfall
- **6 Tasks** (an Projekte/Kontakte verknüpft)
- **2 Rechnungen**, **4 Benachrichtigungen**, **5 Activity-Einträge**
- **1 API-Key** (`Website Lead Intake`) + **1 eingehender Webhook**
(`website-kontaktformular`)
## Sichtbarkeit von Demo-Daten
Einige Listen filtern `isDemoData = true` standardmäßig aus, damit echte
Tenant-Daten nicht mit Demo-Füllstand vermischt werden. Für Review-Screens ggf.
`?demo=show` anhängen oder den UI-Toggle „Demo-Daten anzeigen“ nutzen:
- `http://localhost:3000/hivegrid-demo/contacts?demo=show`
- `http://localhost:3000/hivegrid-demo/projects?demo=show`
- `http://localhost:3000/hivegrid-demo/tasks?demo=show`
## Hinweis: lokale DB-Erreichbarkeit
Das Runtime-`DATABASE_URL` zeigt auf PgBouncer (`localhost:6432`). Läuft PgBouncer
lokal nicht, ist der direkte Postgres-Backend-Port erreichbar (Container
`hivegrid-local-pg`). Zum einmaligen Seeden gegen den direkten Port ohne `.env`
zu ändern:
```bash
DATABASE_URL="postgres://<user>:<pass>@localhost:5434/boilerplate" pnpm seed:demo
```
Es ist dieselbe Datenbank, die die App über PgBouncer liest — Seeding über den
direkten Port schreibt in denselben `boilerplate`-Datenbestand.