Shadcn Registry Starter

screenshot of Shadcn Registry Starter

Overview

The ShadCN Component Registry Starter is an innovative solution designed for developers looking to create and manage a component registry for their custom components, integrating seamlessly with the shadcn CLI. Built on a mix of core files from the shadcn/ui project, this package aims to streamline the process of component management and registration, while keeping future updates in mind as official tooling evolves.

The unofficial nature of this project is underscored by its ongoing development, which promises improvements and updates. Users can easily adapt the starter for their component workflows, offering a simple and efficient way to host and install components using minimal setup. It's a valuable tool for anyone involved in UI design or component development looking to enhance their productivity.

Features

  • Easy Component Registration: Quickly add your components to the registry folder and update the schema for streamlined management.
  • User-Friendly CLI Integration: Utilize the shadcn CLI to install new components effortlessly with simple commands.
  • Built with TypeScript: Leverage the power of TypeScript, ensuring type safety and reducing the risk of runtime errors.
  • Automatic File Generation: Run a single command to build your component registry and generate necessary files to a specified public directory.
  • Customizable Registry Path: Change the default registry path from public/r to suit your project needs, making it flexible and adaptable.
  • Supports Multiple Packages: Incorporates essential packages like lodash.template and ts-morph, providing a solid foundation for component management.
  • Future-Proof Design: Created with the intention of being easily upgradable as official tooling from shadcn becomes available, ensuring longevity for projects.
typescript
Typescript

TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.

zod
Zod

Zod is a TypeScript-first schema declaration and validation library. It allows you to define schemas that can validate data at runtime while providing excellent TypeScript inference, making it perfect for API validation, form validation, and type-safe data handling.