Develop the registry

Local development

Requirements:

• Node.js 20 or newer
• npm 10 or newer

1git clone https://github.com/qentrah/DUI.git
2cd DUI
3npm install
4npm run dev

Open http://localhost:3000.

Before submitting a change:

1npm run lint
2npm run build
3npm run registry:build
4npm run registry:validate

Registry structure

1app/                 Documentation website
2components/ui/       Installable component source
3components/library/  Documentation previews
4lib/                 Shared utilities and catalogs
5public/r/            Generated registry payloads
6registry.json        Registry source of truth
7components.json      Local shadcn configuration

When adding an installable component:

1. Add its source to components/ui.
2. Declare the item and dependencies in registry.json.
3. Add its documentation metadata to lib/catalog.ts.
4. Add a preview and example source.
5. Build and validate the registry.

Contributing

Contributions are welcome. Read CONTRIBUTING.md before opening a pull request. By participating, you agree to follow the CODE_OF_CONDUCT.md.

For security issues, follow the private reporting process in SECURITY.md.