24 lines
992 B
Markdown
24 lines
992 B
Markdown
# registry-template
|
|
|
|
You can use the `shadcn` CLI to run your own component registry. Running your own
|
|
component registry allows you to distribute your custom components, hooks, pages, and
|
|
other files to any React project.
|
|
|
|
> [!IMPORTANT]
|
|
> This template uses Tailwind v3. For Tailwind v4, see [registry-template](https://github.com/shadcn-ui/registry-template-v4).
|
|
|
|
## Getting Started
|
|
|
|
This is a template for creating a custom registry using Next.js.
|
|
|
|
- The template uses a `registry.json` file to define components and their files.
|
|
- The `shadcn build` command is used to build the registry.
|
|
- The registry items are served as static files under `public/r/[name].json`.
|
|
- The template also includes a route handler for serving registry items.
|
|
- Every registry item are compatible with the `shadcn` CLI.
|
|
- We have also added v0 integration using the `Open in v0` api.
|
|
|
|
## Documentation
|
|
|
|
Visit the [shadcn documentation](https://ui.shadcn.com/docs/registry) to view the full documentation.
|