Shadcn Registry Template

Build and Distribute Custom Shadcn/UI Component Registries

This template repository empowers developers to build and distribute their own custom component registries for shadcn/ui. It simplifies packaging your unique shadcn components, making them installable via a custom URL using the <code>npx shadcn-ui@latest add</code> command. The template includes features like automatic registry generation and a demo page, streamlining development and sharing of your component collections.

Features:

• Demo Page: Provides a local environment for developing and previewing your custom components.
• Automatic Registry Generation: Automatically creates the necessary JSON registry files based on your component configurations.
• Automatic GitHub Pages Deployment: Simplifies publishing your component registry for easy access via GitHub Pages.
• Typed Registry Configuration: Utilizes TypeScript in <code>registry.ts</code> for autocompletion and type-safe definition of components.
• Comprehensive Component Definition: Allows specifying component name, description, type, dependencies (shadcn and npm), Tailwind config, CSS variables, and files.
• Local Development Server: Supports local component development and testing using Vite.
• Registry Build Command: Generates the distributable registry files for deployment.
• Demo Build Command: Prepares the accompanying demo page for deployment.
• Local Registry Hosting: Enables testing of the registry by hosting it locally for installation in other projects.

Summary:

The shadcn-registry-template offers a streamlined solution for developers to create, manage, and distribute custom shadcn/ui component registries. It automates registry generation, includes a development demo page, and supports easy deployment. This template simplifies extending the shadcn/ui ecosystem with personalized component libraries, promoting reusability and tailored design systems for your projects.