Gamin UI Registry Platform

Source-first UI registry for creative developers. Gamin UI distributes components as editable React source code directly into local workspaces via CLI.

What’s included

• Registry content under registry/
• API routes for listing, fetching, and searching components
• CLI entrypoint: gamin-ui
• Local preview page at /preview
• Metadata validation and smoke tests

Quick start

Install dependencies:

pnpm install

Run the app:

pnpm run dev

Open:

• http://localhost:3000/preview
• http://localhost:3000/api/components
• http://localhost:3000/api/search?q=hero

CLI

Search the registry:

node ./bin/gamin-ui.js search hero

Add a component to a project:

node ./bin/gamin-ui.js add button --dest ./my-project

Add a component and install its declared dependencies:

node ./bin/gamin-ui.js add hero-modern --dest ./my-project --install

Check for updates:

node ./bin/gamin-ui.js upgrade --check --dest ./my-project

Apply updates:

node ./bin/gamin-ui.js upgrade --dest ./my-project

Registry format

Each component directory contains:

• metadata.json with id, name, version, frameworks, dependencies, and file list
• one or more source files such as .tsx

Example paths:

• registry/button/metadata.json
• registry/button/button.tsx

Testing

Run the smoke test suite:

pnpm test

Run metadata validation only:

pnpm run validate:metadata

Run the combined release check:

pnpm run release:check

• Validate registry metadata.
• Run smoke tests.
• Verify /preview renders the registry components.
• Verify /api/components and /api/search return the expected results.
• Confirm gamin-ui add, search, and upgrade work against a clean temp project.

Contributing

We welcome contributions from the community! Please read our Contributing Guide to learn about our branching model, local development workflows, code standards, and how to submit pull requests.