Szybki start β Zbuduj swoj pierwszy modul
Utworz, skonfiguruj i uruchom modul Insolitum Universe w mniej niz 5 minut. Przewodnik krok po kroku od zera do dzialajacego modulu.
Szybki start
Zbuduj swoj pierwszy modul Insolitum Universe w 5 minut.
Wymagania wstepne
Zanim zaczniesz, upewnij sie, ze masz:
- Node.js >= 18.0
- pnpm >= 8.0 (zalecany) lub npm
- Dostep do instancji Supabase (wspoldzielonej z Universe Shell)
- Dzialajaca instancja Universe Shell (do testowania integracji iframe)
Utworz nowy modul
Wygeneruj szablon za pomoca CLI
Najszybszy sposob na utworzenie nowego modulu:
CLI zapyta o:
- Nazwa modulu β format slug (male litery, laczniki)
- Nazwa wyswietlana β czytelna nazwa dla uzytkownika
- Opis β krotki opis do marketplace
- Kategoria β hr, iot, production, finance, analytics, ai lub other
- Supabase URL β adres URL wspoldzielonego projektu Supabase
- Supabase anon key β publiczny klucz anonimowy
Jesli wolisz reczna konfiguracje, skopiuj szablon z templates/module-starter/ w monorepo.
Przetestuj endpoint health
Sprawdz, czy modul jest poprawnie skonfigurowany:
Oczekiwana odpowiedz:
Endpoint health pod sciezka /api/health jest obowiazkowy. Universe Shell uzywa go do monitorowania stanu modulu, a walidacja marketplace sprawdzi go podczas procesu recenzji.
Przetestuj w Universe Shell
- Uruchom Universe Shell na domyslnym porcie
- Zaloguj sie jako administrator
- Przejdz do Panel administracyjny β Moduly
- Dodaj nowy modul z adresem URL:
http://localhost:3010 - Modul zaladuje sie w ramce iframe Shell z automatycznym uwierzytelnianiem
Shell wysyla do modulu sesje uwierzytelniania za pomoca postMessage. Komponent ShellAuthProvider w module obsluguje to automatycznie β nie wymaga dodatkowej konfiguracji.
Struktura projektu
Po wygenerowaniu szablonu modul ma nastepujaca strukture:
Dodawanie nowej strony
Tworzenie stron zgodnie z konwencja Next.js App Router:
Dostepna pod adresem http://localhost:3010/reports.
Wdrozenie na Vercel
Wypchnij modul do repozytorium Git.
Utworz nowy projekt na Vercel i polacz repozytorium.
Dodaj zmienne srodowiskowe w ustawieniach projektu Vercel:
NEXT_PUBLIC_SUPABASE_URLNEXT_PUBLIC_SUPABASE_ANON_KEYNEXT_PUBLIC_MODULE_IDNEXT_PUBLIC_MODULE_VERSION
Wdroz. Twoj modul jest teraz dostepny pod adresem https://my-analytics.vercel.app.
Co dalej?
- Architektura β Jak dzialaja moduly w Universe
- Uwierzytelnianie β Szczegoly integracji z uwierzytelnianiem Shell
- Baza danych β Zapytania Supabase z izolacja wielodostepowa
- Zdarzenia w czasie rzeczywistym β Subskrypcja zdarzen NATS
- Marketplace β Opublikuj modul i zarabiaj
- Walidator modulow β Przetestuj modul przed zgloszeniem