# AGENTS.md

Get a full fake REST API with zero coding in less than 30 seconds (seriously)

## 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 prepublishOnly
pnpm fmt
pnpm fmt:check
```

## Layout

- `src/` 16 source files

## Conventions

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

---

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.