# AGENTS.md

A React Framework for building  internal tools, admin panels, dashboards & B2B apps with unmatched flexibility.

## Setup

```
pnpm install
```

## Commands

```
pnpm dev        # run locally
pnpm start      # run the app
pnpm build      # produce a build
pnpm test       # run the test suite, must pass before any commit
pnpm lint       # lint
pnpm attw
pnpm attw:all
pnpm biome
```

## Layout

- `examples/`      3731 source files
- `packages/`      2081 source files
- `documentation/` 862 source files
- `cypress/`       99 source files
- `scripts/`       1 source file

## Conventions

- Tests live alongside the code they cover, following `documentation/k8s/refine-documentation/templates/tests/test-connection.yaml`.
- TypeScript is not in strict mode. Turning it on catches a whole class of mistakes before they run.
- CI defines what passing means. See `.github/workflows/build-examples.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `documentation/src/refine-theme/icons/landing-app-crm.tsx` is 287KB. 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.