Skip to main content

Getting Started

Erste Schritte für Plugin-/Theme-Entwicklung und Monorepo-Entwicklung an CockpitOS.

Zwei Wege

ZielVorgehen
Plugin/Theme ohne ganzes Monorepo@cockpitos/sdk — CLI create-block, create-theme
Plattform mit Dashboard, API, WebsiteDieses Repository klonen — siehe Root README

CockpitOS SDK (extern / Monorepo)

Das SDK unter packages/sdk erzeugt Scaffold-Projekte für Block- und Theme-Plugins.

Monorepo (empfohlen für SMG-Entwickler)

pnpm install
pnpm --filter @cockpitos/sdk build
pnpm --filter @cockpitos/sdk exec cockpitos create-block my-hero-block
cd my-hero-block && npm install && npm run dev

Global (externe Autoren)

npm install -g @cockpitos/sdk
cockpitos create-block my-hero-block
cd my-hero-block && npm install && npm run dev

Hinweis: cockpitos dev im SDK ist derzeit ein Stub. Entwicklung im erzeugten Projekt über npm run dev. Es gibt kein create-service / create-plugin in der CLI.

Details: packages/sdk/README.md


Monorepo Quick Start

Node.js ≥ 22.13, pnpm 10.x

pnpm install
pnpm db:generate
pnpm db:push # oder pnpm db:migrate
pnpm --filter @mall-os/dashboard dev # http://localhost:3000

Weitere Apps: Center Manager 3001, Signage 3002, Center-Website 3004 — siehe Root-README.


Öffentliche API & v0

Externe Websites (v0, Vercel) lesen Live-Daten ohne Dashboard-Login:


Weitere Dokumentation

Voraussetzungen

  • Node.js: ≥ 22.13 (Monorepo)
  • TypeScript: ≥ 5.0
  • React / Next.js: wie in package.json der jeweiligen App

Ältere Abschnitte zu Storybook/Playground und create-service wurden entfernt — standen nicht im Einklang mit dem SDK im Repository.

Nutzungsstatistik: Seitenaufrufe werden anonymisiert erfasst. Im Umami-Dashboard nach diesem Pfad filtern: /en/developer-guide/getting-started