Skip to content

Latest commit

 

History

History
63 lines (43 loc) · 1.36 KB

README.md

File metadata and controls

63 lines (43 loc) · 1.36 KB

shadcn Storybook Registry

This is a registry of storybook stories for all the shadcn components. Build using the shadcn-registry-template and using the shadcn CLI to build the registry.

How to Use

The shadcn CLI allows you to import any component or file as long as you point it to a registry JSON. This registry is a JSON file that contains all the information needed to build the registry.

npx shadcn@latest add <Registry URL>

You can visit the storybook registry and copy the URL to the registry JSON file or copy the command directly.

How to Contribute

Getting Started

  1. Clone the repository

  2. Install the dependencies

    bun install

  3. Run the development server

    bun dev

  4. Add/update the stories in the src/registry directory

  5. Add/update the registry.json file

  6. Build the registry

    bun registry:build

Testing

  1. Run the local development server

    bun dev

  2. test the registry by running the shadcn CLI

    npx shadcn@latest add http://localhost:3000/r/your-component.json

Documentation

Visit the shadcn documentation to view the full documentation.