# AGENTS.md

🌐 The Internet Computer! Free, Open-Source, and Self-Hostable.

## Setup

```
npm ci
```

## Commands

```
npm run dev                     # run locally
npm run start                   # run the app
npm run build                   # produce a build
npm run typecheck               # type check without emitting
npm run test:backend
npm run test:backend:postgres
npm run test:puterjs
npm run test:puterjs:node
```

## Layout

- `src/`        1110 source files
- `extensions/` 16 source files
- `tools/`      11 source files

## Conventions

- Tests live alongside the code they cover, following `extensions/appTelemetry.test.ts`.
- 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-provider-integration-tests.yaml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `src/gui/src/lib/jquery-ui-1.13.2/jquery-ui.js` is 517KB. 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.