# AGENTS.md

🕵️‍♂️ All-in-one OSINT tool for analysing any website

## Setup

```
yarn install
```

## Commands

```
yarn dev           # run locally
yarn start         # run the app
yarn build         # produce a build
yarn typecheck     # type check without emitting
yarn lint          # lint
yarn dev:vercel
yarn dev:netlify
yarn dev:api
```

## Layout

- `src/` 132 source files
- `api/` 42 source files

## Conventions

- Tests live alongside the code they cover, following `public/resources/openapi-spec.yml`.
- 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

- Copy `.env.sample` 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.