Docs

Installation

Graphite UI is a Next.js app, not a published package. You run it from a checkout, and everything on the site is generated live from whatever source color you set.

Requirements

Node 24 and pnpm 10: the versions CI pins. Anything older is untested rather than unsupported, but the lockfile is resolved against these two.

Run it

pnpm install
pnpm dev

The dev server listens on port 3000. The port is fixed, so two checkouts cannot serve at once: the second attaches to the first and you end up testing the wrong code.

Why webpack

Turbopack breaks on this project’s Sass, so --webpack is baked into both the dev and build scripts. Leave it there. If you invoke Next directly, pass the flag yourself.

Checks

Six checks gate a change, and they run as one required governance job on every pull request. They read committed snapshots rather than the network, so they work offline.

pnpm typecheck: tsc --noEmit
pnpm drift-check: Components against their contracts
pnpm token-drift: Foundations against the Figma snapshot
pnpm token-drift:test: Self-test for the token drift checker
pnpm component-doc-drift: docs/components against the kit snapshot
pnpm component-doc-drift:test: Self-test for the component doc checker

main is protected: every change lands through a pull request with governance green, including one-line doc edits.