Getting Started

Introduction

Nim UI is a monorepo-oriented UI ecosystem that keeps design tokens, React components, docs, and future CLI workflows aligned from the beginning.

Why this architecture

The repository separates tokens, utilities, component code, docs, and release infrastructure into focused packages so each concern can evolve without dragging unrelated complexity across the workspace.

That structure makes the project easier to understand for contributors and easier to govern for maintainers who need confidence around public API changes and release behavior.

What ships today

The baseline includes a tokens package, shared utilities, a React UI package, a CLI foundation for future init and add workflows, and a Next.js docs app that demonstrates the full path from tokens to components.

  • pnpm workspace + Turborepo orchestration
  • Strict TypeScript and shared configs
  • Changesets-based release flow
  • Open-source governance and contribution docs

Repository map

The package map is intentionally small so maintainers can scale the ecosystem with predictable conventions instead of one-off patterns.

Repository structure ยท bash
apps/docs
packages/ui
packages/tokens
packages/utils
packages/cli
packages/eslint-config
packages/tsconfig
.github
.changeset