# AGENTS.md

🧡 Folo is the AI RSS Reader

## Setup

```
pnpm install
```

## Commands

```
pnpm test             # run the test suite, must pass before any commit
pnpm typecheck        # type check without emitting
pnpm lint             # lint
pnpm format           # format
pnpm build:packages
pnpm build:web
pnpm dedupe:locales
pnpm depcheck
```

## Layout

- `apps/`     2201 source files
- `packages/` 419 source files
- `scripts/`  8 source files
- `plugins/`  5 source files
- `api/`      1 source file

## Conventions

- Tests live alongside the code they cover, following `.github/scripts/build-ota-release.test.ts`.
- TypeScript is not in strict mode. Turning it on catches a whole class of mistakes before they run.
- CI defines what passing means. See `.github/workflows/build-android.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.