NimJS / UIGet started
Browse documentation

Getting Started

Introduction

NimJS UI is an early-stage React component ecosystem that keeps design tokens, React components, docs, and a local CLI workflow 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 repository includes token and utility packages, preview React components, local init and add commands, and a Next.js documentation app. The packages are not publicly released; external testing uses packed artifacts.

  • 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/registry
packages/cli
packages/eslint-config
packages/tsconfig
.github
.changeset