Skip to content

docs(readme): melhorar guia de readiness para produção #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
john-dalmolin merged 1 commit into from
Feb 11, 2026
Merged

docs(readme): melhorar guia de readiness para produção #24

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 19 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Escopo principal:

- Node.js 20 LTS
- Express 5
- TypeScript 7
- TypeScript 5.9
- Prisma 7 + PostgreSQL
- Redis (ioredis)
- JWT (`jsonwebtoken`) + `bcryptjs`
Expand Down Expand Up @@ -78,12 +78,12 @@ Middlewares críticos:

Últimas entregas relevantes em `main`:

- `#14` estabilidade de runtime de testes (teardown Prisma)
- `#15` aumento de branch coverage em fluxos de auth/rate limiter
- `#16` redução de ruído de logs em execução de teste
- `#18` cobertura completa de branches em `src/config/prisma.ts`
- `#19` cobertura completa de branches em `src/logger.ts`
- `#20` cobertura completa de branches em `validate.ts` e `errorHandler.ts`
- [#14](https://github.com/john-dalmolin/auth-api-node/pull/14) estabilidade de runtime de testes (teardown Prisma)
- [#15](https://github.com/john-dalmolin/auth-api-node/pull/15) aumento de branch coverage em fluxos de auth/rate limiter
- [#16](https://github.com/john-dalmolin/auth-api-node/pull/16) redução de ruído de logs em execução de teste
- [#18](https://github.com/john-dalmolin/auth-api-node/pull/18) cobertura completa de branches em `src/config/prisma.ts`
- [#19](https://github.com/john-dalmolin/auth-api-node/pull/19) cobertura completa de branches em `src/logger.ts`
- [#20](https://github.com/john-dalmolin/auth-api-node/pull/20) cobertura completa de branches em `validate.ts` e `errorHandler.ts`

## Backlog atual

Expand All @@ -102,14 +102,16 @@ Subir infraestrutura e aplicação:
```bash
docker-compose up -d postgres redis
npm install
npx prisma migrate deploy
npx prisma generate
npm run dev
```

Arquivo `.env`:

```env
DATABASE_URL="postgresql://auth_user:auth_password@localhost:5432/auth_api"
JWT_SECRET="super_secret_key"
JWT_SECRET="<gere-um-segredo-forte-com-no-minimo-32-caracteres>"
PORT=3000
REDIS_URL="redis://localhost:6379"
RATE_LIMIT_WINDOW_MS=60000
Expand All @@ -128,6 +130,15 @@ Para testes, usar `tests/.env.test`.
- `npm run test:coverage:jest`: cobertura com Jest
- `npm run typecheck`: verificação de tipos

## Validação rápida

```bash
npm run lint
npm run test:coverage:jest
npx jest --config jest.config.cjs --runInBand --detectOpenHandles --openHandlesTimeout=5000
```


## Endpoints principais

- `POST /auth/register`
Expand Down