1.2.1 • Published 5 months ago

@gdavis1361/components v1.2.1

Weekly downloads
-
License
-
Repository
-
Last release
5 months ago

shadcn Storybook Registry

This is a comprehensive registry of Storybook stories for all the shadcn/ui components. Built using the shadcn-registry-template and the shadcn CLI, this repository provides a complete set of accessible, customizable UI components with full Storybook documentation.

Migrating to Storybook v9

The registry is now using Storybook v9. This means that the components are now using the latest storybook/\* packages. Depending on the framework you are using, you may need to update the stories once imported.

If you have not migrated to Storybook v9 yet, you can still use the previous registry by replacing the **/registry/** path with **/v1/r/**. These versions will be kept as an archive and never updated.

If you have any questions, please open an issue.

Features

  • React 19 Compatible: Built with React 19 and Next.js 15
  • Storybook v9: Modern Storybook documentation for all components
  • Accessible Components: Built on Radix UI primitives for maximum accessibility
  • Customizable: Tailwind CSS styling with easy theming
  • TypeScript: Fully typed components for type safety
  • Testing: Comprehensive Vitest test suite
  • AI-Ready: Component manifests enable intelligent component discovery and recommendations

How to Use

The shadcn CLI allows you to import any component or file by pointing it to a registry JSON. This registry contains all the information needed to build and customize the components.

npx shadcn@latest add <Registry URL>

You can visit the Storybook registry and either:

  • Copy the URL to the registry JSON file
  • Copy the command directly from the component page
  • Use the convenient command block on each component page

How to Contribute

Getting Started

  1. Clone the repository

    git clone https://github.com/gdavis1361/prep-frontend.git
    cd prep-frontend
  2. Install the dependencies

    bun install
  3. Run the development server

    bun dev

    This will start the Next.js application on http://localhost:3000

  4. Run Storybook (optional)

    bun storybook

    This will start Storybook on http://localhost:6006

  5. Add/update stories in the components directory

  6. Add/update the registry.json file
  7. 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

Component Manifests

This project includes a comprehensive manifest system for all components:

  • 96.2% Coverage: 125 out of 130 components have detailed manifests
  • AI Integration: Manifests power intelligent component discovery
  • Rich Metadata: Each manifest includes category, intent, complexity, and usage guidance
  • Components Index: All component data aggregated in components-index.json

To validate manifests:

bun run scripts/validate-manifests.ts

To regenerate manifests:

bun run scripts/generate-component-manifests-simple.ts

To regenerate the components index:

bun run scripts/generate-components-index.ts

Documentation

License

This project is licensed under the MIT License - see the LICENSE file for details.