# AGENTS.md

👨🏻‍💻👩🏻‍💻 Use Ant Design like a Pro!

## Setup

```
npm ci
```

## Commands

```
npm run dev           # run locally
npm run start         # run the app
npm run build         # produce a build
npm run test          # run the test suite, must pass before any commit
npm run lint          # lint
npm run analyze
npm run deploy
npm run i18n-remove
```

## Layout

- `src/`               239 source files
- `cloudflare-worker/` 17 source files
- `config/`            6 source files
- `mock/`              6 source files
- `tests/`             3 source files
- `scripts/`           2 source files

## Conventions

- Tests live alongside the code they cover, following `src/access.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/antd-cli.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `src/pages/dashboard/monitor/mock/map-grid.ts` is 908KB. 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.