# AGENTS.md

A set of beautifully-designed, accessible components and a code distribution platform. Works with your favorite frameworks. Open Source. Open Code.

## Setup

```
pnpm install
```

## Commands

```
pnpm dev              # run locally
pnpm build            # produce a build
pnpm test             # run the test suite, must pass before any commit
pnpm typecheck        # type check without emitting
pnpm lint             # lint
pnpm check            # lint and type check
pnpm build:packages
pnpm registry:build
```

## Layout

- `apps/`      3409 source files
- `packages/`  441 source files
- `templates/` 65 source files
- `scripts/`   1 source file

## Conventions

- Tests live alongside the code they cover, following `apps/v4/app/(app)/(create)/init/route.test.ts`.
- TypeScript runs in strict mode. Type errors are the fastest feedback available, so do not weaken it.
- CI defines what passing means. See `.github/workflows/browser-tests.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `apps/v4/registry/__index__.tsx` is 1051KB. It will not fit comfortably in context, so read it in parts.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.