create-lego-box

Scaffolds a new Lego Box microfrontend app with ui-kit, pilets, and shell from npm.

Usage

From npm (recommended for external developers)

pnpm create lego-box
# or
npm create lego-box

From monorepo (local development)

pnpm create:app
# or
node packages/create-lego-box/index.js

With app name

pnpm create lego-box my-awesome-app

What it creates

/my-app
  package.json
  pnpm-workspace.yaml
  tsconfig.base.json
  .env.example
  scripts/
    dev-all-pilets.js
    dev-multi-pilet.js
    discover-pilets.js
    update-scaffold.js
    run-shell.js
  packages/
    ui-kit/         # Extensible – re-exports @lego-box/ui-kit, add custom components here
    create-pilet/   # CLI to scaffold new pilets
  pilets/
    my-pilet/       # Initial pilet

Architecture

• Shell: @lego-box/shell from npm (maintained by Lego Box team)
• ui-kit: Local workspace package – extends @lego-box/ui-kit, add your components
• Pilets: Create with pnpm create:pilet – auto-saved to pilets/

Next steps after creation

1. cd my-app
2. pnpm install (if not run automatically)
3. Start PocketBase: pb serve (or your PocketBase setup)
4. pnpm dev – runs shell + ui-kit + all pilets
5. Add pilets: pnpm create:pilet
6. Extend ui-kit: edit packages/ui-kit/src/components/

Updating your scaffolded app

To get the latest shell, ui-kit, and scaffold template files (README, scripts, configs):

pnpm update

Or step by step:

pnpm update @lego-box/shell@latest @lego-box/ui-kit@latest
pnpm update create-lego-box@latest
pnpm update:scaffold

Note: update:scaffold pulls latest template files but does not modify your pilets or custom components in packages/ui-kit/src/components/.

Publishing

To publish to npm for pnpm create lego-box:

1. Add to changesets
2. Publish as create-lego-box (unscoped) or @lego-box/create (scoped)

The create-* convention: pnpm create foo runs the create-foo package.