# AGENTS.md

Set up a modern web app by running one command.

## Setup

```
npm ci
```

## Commands

```
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 format             # format
npm run changelog
npm run create-react-app
npm run e2e
npm run e2e:docker
```

## Layout

- `packages/`   229 source files
- `test/`       53 source files
- `tasks/`      13 source files
- `docusaurus/` 2 source files

## Conventions

- Tests live alongside the code they cover, following `.github/workflows/build-and-test.yml`.
- CI defines what passing means. See `.github/workflows/build-and-test.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `packages/react-error-overlay/fixtures/bundle_u.mjs` is 1407KB. 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.