# AGENTS.md

Open Source realtime backend in 1 file

## Setup

```
go mod download
```

## Commands

```
make lint          # lint
make test          # run the test suite, must pass before any commit
make jstypes
make test-report
```

## Layout

- `ui/`      192 source files
- `tools/`   185 source files
- `core/`    139 source files
- `apis/`    77 source files
- `plugins/` 20 source files
- `forms/`   8 source files

## Conventions

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

## Gotchas

- `plugins/jsvm/internal/types/generated/types.d.ts` is 782KB. 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.