Registry Directory

The open source registry index is a list of all the open source registries that are available to use out of the box.

When you run JGuang UI Registry or JGuang UI Registry, the CLI will automatically check the registry index for the registry you are looking for and add it to your components.json file.

You can see the full list at /systems/jguang-ui#open-source-attribution.

You do not need to submit a public GitHub registry to the registry directory to use it with owner/repo/item addresses. The registry directory is for namespaces such as @acme.

Adding a Registry

1. Add your registry to apps/v4/registry/directory.json
2. Run pnpm validate:registries to validate the registry directory.
3. Create a pull request to /systems/jguang-ui#open-source-attribution

Once you have submitted your request, it will be validated and reviewed by the team.

Requirements

1. The registry must be open source and publicly accessible.
2. The registry must be a valid JSON file that conforms to the registry schema specification.
3. The registry is expected to be a flat registry with no nested items i.e /registry.json and /component-name.json files are expected to be in the root of the registry.
4. The files array, if present, must NOT include a content property.

Here's an example of a valid registry:

Use the JGuang UI Registry URL provided on /systems/jguang-ui#install.