Static UIStatic UI Docs

Development Workflow

How to set up and work with the Static UI monorepo.

Prerequisites

  • Node.js 20+
  • PNPM 11.5+
  • Git

Setup

git clone https://github.com/Anshul563/static-ui.git
cd static-ui
pnpm install
pnpm build

Development Loop

  1. Make changes in the appropriate package
  2. Run pnpm typecheck to verify types
  3. Run pnpm test to run tests
  4. Run pnpm lint for code quality
  5. Commit using conventional commits (enforced by commitlint)
  6. Push — CI will run all checks automatically

Pre-commit Hooks

Husky automatically runs:

  • pre-commit: lint-staged (eslint + prettier on staged files)
  • commit-msg: commitlint (conventional commit validation)
  • pre-push: typecheck + build

Adding a New Component

  1. Create the component file in packages/ui/src/
  2. Export it from packages/ui/src/index.ts
  3. Add entry to packages/registry/registry.json
  4. Add dependency override in build-registry.ts if needed
  5. Run pnpm registry to rebuild the registry
  6. Run pnpm validate:registry to verify