Village Kit UI

A React component library for Village Kit projects, built on Chakra UI.

Design principles

• Playful vibes
• Functional interfaces
• Maintainable code
• Accessible HTML

Demo

Check out the storybook:

TODO https://ui.villagekit.com

Where is this used?

• TODO new gridbeam.xyz
• TODO new villagekit.com
• old gridkit.nz (legacy)

Dev

Requires Node 22.12+ (matches Storybook 10's minimum).

git clone git@github.com:villagekit/ui
cd ui
pnpm install
pnpm run dev

pnpm run dev starts Storybook on port 6006.

Scripts

• dev — Storybook dev server
• build:pkg — build the package via tsup to dist/
• build:storybook — build the Storybook static site to storybook-static/
• lint — Biome check
• types — tsc --noEmit
• publint — verify the published package layout

Releasing

npm version <patch|minor|major>
git push --follow-tags

Pushing a v* tag triggers the release workflow to build and publish to npm.

License

Licensed under the EUPL v1.2 (?)