Vibekit

Schnellstart

Richte das Repository ein und starte VibeKit in wenigen Minuten lokal.

Verwenden Sie Bun 1.3.13, festgelegt in .bun-version und package.json, sowie Docker Compose für die mitgelieferten lokalen Dienste.

1. Abhängigkeiten installieren und PostgreSQL starten

bun --version
bun install --frozen-lockfile
docker compose up -d postgres

Warten Sie, bis PostgreSQL gesund ist. Der Compose-Dienst nutzt lokale Entwicklungszugangsdaten und Port 5432; machen Sie ihn nicht öffentlich erreichbar.

2. Wegwerfbare lokale Datenbank einrichten

Das Setup-Skript verlangt eine explizit exportierte lokale DATABASE_URL und --disposable, weil es das Schema verändert:

export DATABASE_URL="postgresql://postgres:[email protected]:5432/vibekit"
bun run setup:local --disposable

Bei fehlender .env kopiert es .env.example als Ausgangspunkt, ersetzt BETTER_AUTH_SECRET und APP_ENCRYPTION_KEY durch frisch erzeugte Zufallswerte, setzt MOCK_SERVICES=true und schreibt die Datei mit Rechten nur für den Besitzer. Anschließend wendet es die eingecheckte Migrationskette an und generiert Prisma-Client und Zod-Typen. Es installiert keine Abhängigkeiten und startet PostgreSQL nicht. Halten Sie die Datenbank-URL in .env mit der gewählten Testdatenbank synchron; eine vorhandene .env bleibt erhalten. Geben Sie die erzeugten Secrets niemals aus und committen Sie sie nicht.

Existiert .env bereits, setzen Sie selbst ein lokales BETTER_AUTH_SECRET mit mindestens 32 Zeichen und MOCK_SERVICES=true. Damit wählen Sie die Offline-Pfade für Zahlungen, E-Mail, Speicher und KI explizit aus. Fehlende Zugangsdaten aktivieren nicht bei jedem Anbieter einen Mock, besonders nicht in Produktion. Committen Sie .env niemals.

3. App starten

bun run dev

Die App läuft unter http://localhost:3000, die Dokumentation unter /docs. Starten Sie bun run mail:preview separat für die E-Mail-Vorschau unter http://localhost:3005.

Mock-Speicher unterstützt während der Entwicklung temporäre lokale Uploads und Lesezugriffe. Für Tests der S3-Integration und ihres CORS-Verhaltens folgen Sie Lokale MinIO-Einrichtung. Mock-Upload-/Leserouten lehnen Anfragen im Produktionsmodus ab.

4. Änderungen prüfen

bun run verify
bun run build
bun run e2e

Nutzen Sie für bereitgestellte Datenbanken geprüfte Migrationen, wie unter Datenbank-Migrationen beschrieben. Weiter geht es mit Konfiguration.

Optional: einen KI-Client verbinden

Wenn der Website-Administrator schreibgeschützten KI-Zugriff möchte, folge der MCP-Einrichtung. Dein Agent kann den gewählten Client konfigurieren und einen erlaubten Lesezugriff prüfen, nachdem der Administrator sich angemeldet und Berechtigungen sowie Teams freigegeben hat. Admin-Zugriff erfordert eine ausdrückliche Admin-Zustimmung. Du kannst diese Verbindung überspringen und die normale Einrichtung abschließen; ein separates Auth-System ist nicht nötig.

On this page