# AGENTS.md

A fancy self-hosted monitoring tool

## 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 lint:js
npm run lint:js-prod
npm run lint-fix:js
```

## Layout

- `server/` 208 source files
- `src/`    196 source files
- `db/`     111 source files
- `extra/`  47 source files
- `test/`   46 source files
- `config/` 2 source files

## Conventions

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

## Gotchas

- `src/pages/EditMonitor.vue` is 233KB. 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.