# AGENTS.md

Open Source Alternative to Vercel, Netlify and Heroku.

## Setup

```
pnpm install
```

## Commands

```
pnpm build           # produce a build
pnpm test            # run the test suite, must pass before any commit
pnpm typecheck       # type check without emitting
pnpm check           # lint and type check
pnpm dokploy:setup
pnpm dokploy:dev
pnpm dokploy:build
pnpm dokploy:start
```

## Layout

- `apps/`     952 source files
- `packages/` 281 source files
- `scripts/`  4 source files

## Conventions

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

## Gotchas

- `apps/dokploy/lib/bundled-icons.ts` is 121KB. 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.