Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lloydrichards/shadcn-storybook-registry
Repository of stories for the shadcn components. Quickly get the atomic level components documented in Storybook.
https://github.com/lloydrichards/shadcn-storybook-registry
registry shadcn-ui storybook
Last synced: 9 days ago
JSON representation
Repository of stories for the shadcn components. Quickly get the atomic level components documented in Storybook.
- Host: GitHub
- URL: https://github.com/lloydrichards/shadcn-storybook-registry
- Owner: lloydrichards
- License: mit
- Created: 2025-01-18T20:31:13.000Z (23 days ago)
- Default Branch: main
- Last Pushed: 2025-01-31T10:00:19.000Z (11 days ago)
- Last Synced: 2025-01-31T10:34:26.570Z (11 days ago)
- Topics: registry, shadcn-ui, storybook
- Language: TypeScript
- Homepage: https://registry.lloydrichards.dev
- Size: 1.18 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# shadcn Storybook Registry
This is a registry of [storybook](https://storybook.js.org/) stories for all the
[shadcn](https://ui.shadcn.com/) components. Build using the
[shadcn-registry-template](https://github.com/shadcn-ui/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.
```bash
npx shadcn@latest add
```
You can visit the [storybook registry](https://registry.lloydrichards.dev/) 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
```bash
bun install
```
3. Run the development server
```bash
bun dev
```
4. Add/update the stories in the `src/registry` directory
5. Add/update the `registry.json` file
6. Build the registry
```bash
bun registry:build
```
### Testing
1. Run the local development server
```bash
bun dev
```
2. test the registry by running the shadcn CLI
```bash
npx shadcn@latest add http://localhost:3000/r/your-component.json
```
## Documentation
Visit the [shadcn documentation](https://ui.shadcn.com/docs/registry) to view
the full documentation.