# AGENTS.md

A one-of-a-kind resume builder that keeps your privacy in mind. Completely secure, customizable, portable, open-source and free forever. Try it out today!

## Setup

```
pnpm install
```

## Commands

```
pnpm dev         # run locally
pnpm start       # run the app
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 doctor
pnpm docs:gen
```

## Layout

- `packages/`   504 source files
- `apps/`       425 source files
- `migrations/` 26 source files
- `tests/`      25 source files
- `tooling/`    6 source files

## Conventions

- Tests live alongside the code they cover, following `apps/server/src/http/app.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/autofix.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- 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.