# AGENTS.md

A progressive Node.js framework for building efficient, scalable, and enterprise-grade server-side applications with TypeScript/JavaScript 🚀

## Setup

```
npm ci
```

## Commands

```
npm run build           # produce a build
npm run test            # run the test suite, must pass before any commit
npm run lint            # lint
npm run format          # format
npm run postbuild
npm run build:dev
npm run prebuild:prod
npm run build:prod
```

## Layout

- `packages/`    901 source files
- `integration/` 537 source files
- `sample/`      376 source files
- `tools/`       15 source files
- `scripts/`     6 source files

## Conventions

- Tests live alongside the code they cover, following `integration/auto-mock/test/bar.service.spec.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/codeql-analysis.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

---

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.