Schnellstart β Erstelle dein erstes Modul
Erstelle, konfiguriere und starte ein Insolitum-Universe-Modul in unter 5 Minuten. Schritt-fuer-Schritt-Anleitung vom Anfang bis zum fertigen Modul.
Schnellstart
Erstelle dein erstes Insolitum-Universe-Modul in 5 Minuten.
Voraussetzungen
Bevor du beginnst, stelle sicher, dass du Folgendes hast:
- Node.js >= 18.0
- pnpm >= 8.0 (empfohlen) oder npm
- Zugang zu einer Supabase-Instanz (gemeinsam mit Universe Shell genutzt)
- Eine laufende Universe Shell-Instanz (zum Testen der iframe-Integration)
Neues Modul erstellen
Projekt mit CLI generieren
Der schnellste Weg, ein neues Modul zu erstellen:
Das CLI fragt nach:
- Modulname β Slug-Format (Kleinbuchstaben, Bindestriche)
- Anzeigename β lesbarer Name fuer Benutzer
- Beschreibung β kurze Beschreibung fuer den Marketplace
- Kategorie β hr, iot, production, finance, analytics, ai oder other
- Supabase URL β URL deines gemeinsamen Supabase-Projekts
- Supabase anon key β oeffentlicher anonymer Schluessel
Wenn du die manuelle Einrichtung bevorzugst, kopiere die Vorlage aus templates/module-starter/ im Monorepo.
Health-Endpoint testen
Ueberpruefen, ob dein Modul korrekt konfiguriert ist:
Erwartete Antwort:
Der Health-Endpoint unter /api/health ist obligatorisch. Universe Shell verwendet ihn zur Ueberwachung des Modulstatus, und die Marketplace-Validierung prueft ihn waehrend des Review-Prozesses.
In Universe Shell testen
- Starte Universe Shell auf dem Standardport
- Melde dich als Administrator an
- Navigiere zu Admin-Panel β Module
- Fuege ein neues Modul mit der URL hinzu:
http://localhost:3010 - Dein Modul wird im iframe der Shell mit automatischer Authentifizierung geladen
Die Shell sendet deinem Modul eine Authentifizierungssitzung ueber postMessage. Der ShellAuthProvider in deinem Modul verarbeitet dies automatisch β keine weitere Konfiguration noetig.
Projektstruktur
Nach der Generierung hat dein Modul folgende Struktur:
Neue Seite hinzufuegen
Erstelle Seiten gemaess den Konventionen des Next.js App Routers:
Erreichbar unter http://localhost:3010/reports.
Bereitstellung auf Vercel
Pushe dein Modul in ein Git-Repository.
Erstelle ein neues Projekt auf Vercel und verbinde das Repository.
Fuege Umgebungsvariablen in den Vercel-Projekteinstellungen hinzu:
NEXT_PUBLIC_SUPABASE_URLNEXT_PUBLIC_SUPABASE_ANON_KEYNEXT_PUBLIC_MODULE_IDNEXT_PUBLIC_MODULE_VERSION
Bereitstellen. Dein Modul ist jetzt verfuegbar unter https://my-analytics.vercel.app.
Wie geht es weiter?
- Architektur β Wie Module in Universe funktionieren
- Authentifizierung β Detaillierte Beschreibung der Shell-Auth-Integration
- Datenbank β Supabase-Abfragen mit Mandantenisolierung
- Echtzeit-Ereignisse β NATS-Ereignisse abonnieren
- Marketplace β Veroeffentliche dein Modul und erziele Einnahmen
- Modul-Validator β Teste dein Modul vor der Einreichung