# AGENTS.md

Project NOMAD is an offline-first knowledge and education server. Wikipedia, thousands of books, courses, maps, and optional local AI, all running on hardware you own with no internet required.

## Setup

```
npm ci
```

## Commands

```
npm run test   # run the test suite, must pass before any commit
```

## Layout

- `admin/`   383 source files
- `install/` 11 source files

## Conventions

- Tests live alongside the code they cover, following `admin/tests/bootstrap.ts`.
- CI defines what passing means. See `.github/workflows/build-admin-on-pr.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

---

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.