# AGENTS.md

The most popular HTML, CSS, and JavaScript framework for developing responsive, mobile first projects on the web.

## 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 bundlewatch
npm run bundlewatch:fix
npm run bundlewatch:table
npm run css
npm run css-compile
```

## Layout

- `site/`  151 source files
- `js/`    75 source files
- `build/` 18 source files
- `scss/`  3 source files
- `dist/`  2 source files

## Conventions

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

## Gotchas

- Generated output is committed (`build/`). Search will return the compiled copy, so edit the source, not that.
- `dist/js/bootstrap.bundle.js` is 321KB. 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.