Quickstart

# Clone the kernel repository (or the SDK-only companion repo if provided)
git clone https://github.com/septemcore/platform-kernel.git
cd platform-kernel/.dev/kernel

# Start the full stack (PostgreSQL, ClickHouse, Kafka, RabbitMQ, Valkey, Vault, all services)
docker compose -f docker/docker-compose.yml up -d

# Verify all services are healthy
docker compose -f docker/docker-compose.yml ps

# Scaffold a new module named "my-crm"
npx @platform/create-module@latest my-crm --description "A simple CRM module"

# The generator creates:
# my-crm/
# ├── module.manifest.json   ← Module contract (see Project Structure)
# ├── federation.config.js   ← Module Federation 2.0 remote config
# ├── package.json
# ├── tsconfig.json
# ├── src/
# │   └── pages/
# │       └── index.tsx      ← Main React entry component
# └── migrations/            ← SQL migration files (goose format)

cd my-crm
pnpm install

{
  "name": "@demo/my-crm",
  "version": "1.0.0",
  "description": "A simple CRM module",
  "kernelSdkVersion": "^1.0.0",
  "entry": "",
  "exposedComponent": "MyCrmModule",
  "route": "/crm",
  "icon": "Users",
  "permissions": ["crm.contacts.read", "crm.contacts.write"],
  "events": {
    "publishes": ["crm.contact.created"],
    "subscribes": ["auth.user.created"]
  },
  "healthCheck": "/health",
  "dependencies": {
    "@platform/sdk-auth": "^1.0.0",
    "@platform/sdk-data": "^1.0.0"
  }
}

# Core package (always required — provides types, HTTP client, error handling)
pnpm add @platform/sdk-core

# Add primitives as needed
pnpm add @platform/sdk-auth    # Authentication, RBAC, session management
pnpm add @platform/sdk-data    # CRUD, realtime, analytics
pnpm add @platform/sdk-events  # Kafka/RabbitMQ/browser events
pnpm add @platform/sdk-notify  # Notifications (WebSocket, email, SMS, …)
pnpm add @platform/sdk-files   # File upload, image processing
pnpm add @platform/sdk-money   # Wallets, transactions, holds
pnpm add @platform/sdk-audit   # Audit trail recording

# UI Design System (optional — Tailwind v4 + Radix UI components)
pnpm add @platform/sdk-ui

# Development tools
pnpm add -D @platform/sdk-testing  # Mocks and fixtures for Vitest

import { useAuth } from '@platform/sdk-auth';
import { useQuery } from '@platform/sdk-data';

interface Contact {
  id: string;
  name: string;
  email: string;
  created_at: string;
}

export default function MyCrmModule() {
  // Access current user and tenant from JWT context
  const { user, tenant } = useAuth();

  // Query the 'contacts' model — auto-generated REST endpoint.
  // Resolves to: GET https://api.septemcore.com/api/v1/data/my-crm/contacts?page_size=20
  const { data: contacts, isLoading } = useQuery<Contact>('my-crm', 'contacts', {
    page_size: 20,
    order: 'created_at.desc',
  });

  if (isLoading) {
    return <div>Loading contacts...</div>;
  }

  return (
    <div>
      <h1>CRM — {tenant.name}</h1>
      <p>Logged in as {user.email}</p>

      <table>
        <thead>
          <tr>
            <th>Name</th>
            <th>Email</th>
          </tr>
        </thead>
        <tbody>
          {contacts?.data.map((c) => (
            <tr key={c.id}>
              <td>{c.name}</td>
              <td>{c.email}</td>
            </tr>
          ))}
        </tbody>
      </table>
    </div>
  );
}

# Start the dev server (hot-reload, proxied to sandbox API)
pnpm dev
# → Module Federation remote is now available at http://localhost:5173/remoteEntry.js

# In a separate terminal — register the module with the kernel.
# The CLI reads module.manifest.json automatically.
npx @platform/create-module register \
  --gateway http://localhost:8080 \
  --token <admin_jwt_from_sandbox> \
  --entry http://localhost:5173/remoteEntry.js

# Activate the module for the demo tenant
npx @platform/create-module activate \
  --gateway http://localhost:8080 \
  --token <admin_jwt_from_sandbox>