# Use and adapt rare-ui

Use the documented interfaces and source layout for **rare-ui**. The sections below retain the README’s examples and configuration details.

## Running locally

```bash
git clone https://github.com/Up-to-code/rare-ui.git
cd rare-ui
npm install
npm run dev
```

Components live in `components/ui`. After changing a component or `registry.json`, rebuild the registry output with `npm run registry:build`.

## Commands in the root manifest

The captured [package.json](https://github.com/Up-to-code/rare-ui/blob/HEAD/package.json) declares the following scripts. Run them from the directory containing that manifest.

| Command | Script |
| --- | --- |
| `npm run dev` | `next dev` |
| `npm run build` | `shadcn build && next build` |
| `npm run start` | `next start` |
| `npm run lint` | `eslint` |

## Troubleshoot a local change

1. Reproduce the smallest example from the [quick-start guide](/docs/up-to-code-rare-ui/quick-start-guide).
2. Compare required configuration and dependency versions with the README.
3. Check the linked issue tracker for the same error. Include the command, runtime version, and relevant error when reporting a problem; omit credentials.

## Source and help

- [GitHub repository](https://github.com/Up-to-code/rare-ui)
- [Original README](https://github.com/Up-to-code/rare-ui/blob/main/README.md)
- [Issues and existing reports](https://github.com/Up-to-code/rare-ui/issues)
- [Open the project website](https://rareui.com)


This catalog entry is a fork. The README may describe upstream packages, domains, or release procedures; those destinations do not establish a separate release of this fork.