# AGENTS.md

Independent technology for modern publishing, memberships, subscriptions and newsletters.

## Setup

```
pnpm install
```

## Commands

```
pnpm dev                # run locally
pnpm build              # produce a build
pnpm test               # run the test suite, must pass before any commit
pnpm lint               # lint
pnpm format             # format
pnpm check              # lint and type check
pnpm archive
pnpm build:production
```

## Layout

- `apps/`     2385 source files
- `ghost/`    2245 source files
- `koenig/`   794 source files
- `e2e/`      257 source files
- `packages/` 123 source files
- `scripts/`  39 source files

## Conventions

- Tests live alongside the code they cover, following `.github/scripts/i18n-review/test/analyzer.test.js`.
- CI defines what passing means. See `.github/workflows/ci.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `koenig/kg-simplemde/debug/simplemde.debug.js` is 1544KB. It will not fit comfortably in context, so read it in parts.
- Copy `.env.example` before running anything that needs configuration.

---

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.