# AGENTS.md

f.k.a. Awesome ChatGPT Prompts. Share, discover, and collect prompts from the community. Free and open source — self-host for your organization with complete privacy.

## Setup

```
npm ci
```

## Commands

```
npm run dev           # run locally
npm run start         # run the app
npm run build         # produce a build
npm run test          # run the test suite, must pass before any commit
npm run lint          # lint
npm run db:deploy
npm run db:generate
npm run db:migrate
```

## Layout

- `src/`      464 source files
- `packages/` 39 source files
- `scripts/`  11 source files
- `prisma/`   2 source files
- `docker/`   1 source file
- `tests/`    1 source file

## Conventions

- Tests live alongside the code they cover, following `packages/prompts.chat/src/__tests__/builder.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/ci.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `scripts/generate-book-pdf.ts` is 149KB. 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.