Skip to content

lloydrichards/shadcn-storybook-registry

Repository files navigation

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

Add Registry to Your Project

Configure this registry in your components.json:

{
  "registries": {
    "@storybook": "https://registry.lloydrichards.dev/v2/r/{name}.json"
  }
}

Install Components

# Install using registry namespace
npx shadcn@latest add @storybook/button-story

# Or install directly via URL
npx shadcn@latest add https://registry.lloydrichards.dev/v2/r/button-story.json

You can visit the storybook registry to browse available components and copy installation commands.

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/v2/r/your-component.json

Documentation

Visit the shadcn documentation to view the full documentation.

About

Repository of stories for the shadcn components. Quickly get the atomic level components documented in Storybook.

Topics

Resources

License

Stars

Watchers

Forks

Languages