# AGENTS.md

AdminLTE - Free admin dashboard template based on Bootstrap 5

## Setup

```
npm ci
```

## Commands

```
npm run dev           # run locally
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 lint          # lint
npm run css
npm run css-compile
npm run css-rtl
```

## Layout

- `src/`     134 source files
- `dist/`    14 source files
- `tests/`   11 source files
- `scripts/` 2 source files

## Conventions

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

## Gotchas

- Generated output is committed (`dist/`). Search will return the compiled copy, so edit the source, not that.

---

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.