# AGENTS.md

Modern CSS framework based on Flexbox

## Setup

```
npm ci
```

## Commands

```
npm run start                         # run the app
npm run test                          # run the test suite, must pass before any commit
npm run build-bulma
npm run minify-bulma
npm run version-no-dark-mode
npm run version-no-helpers
npm run version-no-helpers-prefixed
npm run version-prefixed
```

## Layout

- `docs/` 94 source files
- `test/` 4 source files

## Conventions

- Tests live alongside the code they cover, following `docs/cypress/e2e/base/generic.spec.js`.
- CI defines what passing means. See `.github/workflows/main.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `docs/assets/javascript/bulma-customizer/index.js` is 201KB. 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.