# AGENTS.md

A boilerplate for Node.js web applications

## Setup

```
npm ci
```

## Commands

```
npm run start           # run the app
npm run test            # run the test suite, must pass before any commit
npm run lint            # lint
npm run clean-install
npm run lint-check
npm run postinstall
npm run prepare
npm run scss
```

## Layout

- `test/`        37 source files
- `controllers/` 7 source files
- `config/`      6 source files
- `public/`      3 source files
- `models/`      2 source files

## Conventions

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

## Gotchas

- Copy `.env.example` before running anything that needs configuration.

---

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.