@mirascope/ui v0.1.0

Mirascope UI

A component registry for React projects, built on shadcn/ui patterns with automatic synchronization capabilities.

Using the Registry

To use components from this registry in your project:

# Install the CLI tool
bun add -D @mirascope/ui

# Initialize your project
bunx mirascope-ui init

# Add components
bunx mirascope-ui add button dialog

# Keep components in sync
bunx mirascope-ui sync

The components will be installed to ./mirascope-ui at the root of your project (alongside package.json).

For complete CLI documentation, see CLI.md.

Development

This section covers developing the registry itself (adding new components, testing, etc).

ShadCN Registry Docs

https://ui.shadcn.com/docs/registry

How to add components

1. Create a file inside registry
2. Update registry.json and append a new registry-item
3. Build registry

bun build

Typechecking

bun run typecheck

Testing

bun test

How to pull components

Use the mirascope-ui CLI command (see above). Note it has --local and --target options which facilitate testing locally current versions of the components in your target destination of choice.

Storybook

Start Storybook

bun storybook

License

Everything in this repository is licensed under the MIT License except for "Williams-Handwriting-Regular-v1.{x}.tff", which is a closed license font and not available for use without express permission.