Skip to content

Commit 7d7656b

Browse files
author
Alejandro
committed
Atualizando readme com as instruções para desenvolvimento
2 parents 4571fef + 337a301 commit 7d7656b

2 files changed

Lines changed: 35 additions & 27 deletions

File tree

README.md

Lines changed: 34 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,20 @@ O **EventDev Server** é a API backend para a plataforma EventDev, construída c
1515
- **Cache/Rate Limit**: Redis
1616
- **Compilação**: SWC (Speedy Web Compiler) para desenvolvimento rápido.
1717

18+
## Ferramentas necessárias
19+
20+
- [**node.js**](https://nodejs.org/en/download)
21+
- [**docker**](https://www.docker.com/get-started/)
22+
- [**pnpm**](https://pnpm.io/pt/installation)
23+
1824
## Scripts Principais
1925

2026
### Desenvolvimento
2127

22-
- `pnpm start-dev`: Inicia o servidor em modo de desenvolvimento (com hot-reload e SWC).
23-
- `pnpm start-debug`: Inicia em modo debug.
28+
```bash
29+
pnpm install #para instalar dependências
30+
pnpm run dev #para iniciar o servidor de desenvolvimento
31+
```
2432

2533
### Testes
2634

@@ -64,46 +72,46 @@ Abaixo estão os comandos essenciais organizados por ferramenta e caso de uso.
6472

6573
O `Makefile` é a interface principal para gerenciar a infraestrutura Docker.
6674

67-
| Comando | Caso de Uso | Descrição |
68-
| :--- | :--- | :--- |
69-
| `make dev-up` | **Início do Dia** | Sobe todo o ambiente de desenvolvimento (API + Banco + Redis + Auth). Inclui script de inicialização (`init-dev.sql`) para criar os bancos separadamente. |
70-
| `make dev-down` | **Fim do Dia** | Para e remove todos os containers e volumes de desenvolvimento. |
71-
| `make dev-logs` | **Monitoramento** | Exibe os logs da API em tempo real. |
72-
| `make dev-shell` | **Debug Avançado** | Abre um terminal `sh` dentro do container da API. |
73-
| `make test-deps-up` | **Testes Locais** | Sobe apenas as dependências (DB/Redis) para rodar testes locais (`pnpm test`). |
74-
| `make verify-all` | **CI/CD** | Executa a verificação completa (lint, testes, build) dentro do container. |
75-
| `make db-studio` | **Gestão de Dados** | Abre o Prisma Studio para visualizar/editar dados do banco. |
75+
| Comando | Caso de Uso | Descrição |
76+
| :------------------ | :------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------- |
77+
| `make dev-up` | **Início do Dia** | Sobe todo o ambiente de desenvolvimento (API + Banco + Redis + Auth). Inclui script de inicialização (`init-dev.sql`) para criar os bancos separadamente. |
78+
| `make dev-down` | **Fim do Dia** | Para e remove todos os containers e volumes de desenvolvimento. |
79+
| `make dev-logs` | **Monitoramento** | Exibe os logs da API em tempo real. |
80+
| `make dev-shell` | **Debug Avançado** | Abre um terminal `sh` dentro do container da API. |
81+
| `make test-deps-up` | **Testes Locais** | Sobe apenas as dependências (DB/Redis) para rodar testes locais (`pnpm test`). |
82+
| `make verify-all` | **CI/CD** | Executa a verificação completa (lint, testes, build) dentro do container. |
83+
| `make db-studio` | **Gestão de Dados** | Abre o Prisma Studio para visualizar/editar dados do banco. |
7684

7785
### PNPM (Ciclo de Desenvolvimento)
7886

7987
Comandos para o dia a dia de codificação.
8088

81-
| Comando | Caso de Uso | Descrição |
82-
| :--- | :--- | :--- |
83-
| `pnpm start-dev` | **Codificação** | Roda a API localmente com hot-reload (SWC). |
84-
| `pnpm lint` | **Qualidade** | Verifica e corrige problemas de estilo de código. |
85-
| `pnpm test-all` | **Validação** | Roda testes unitários e E2E em sequência. |
86-
| `pnpm verify-all` | **CI/CD** | Roda lint, testes e build para garantir integridade total. |
87-
| `pnpm build` | **Deploy** | Compila o projeto para a pasta `dist` (produção). |
89+
| Comando | Caso de Uso | Descrição |
90+
| :---------------- | :-------------- | :--------------------------------------------------------- |
91+
| `pnpm start-dev` | **Codificação** | Roda a API localmente com hot-reload (SWC). |
92+
| `pnpm lint` | **Qualidade** | Verifica e corrige problemas de estilo de código. |
93+
| `pnpm test-all` | **Validação** | Roda testes unitários e E2E em sequência. |
94+
| `pnpm verify-all` | **CI/CD** | Roda lint, testes e build para garantir integridade total. |
95+
| `pnpm build` | **Deploy** | Compila o projeto para a pasta `dist` (produção). |
8896

8997
### Docker (Infraestrutura)
9098

9199
Comandos diretos do Docker Compose (geralmente abstraídos pelo Makefile).
92100

93-
| Comando | Caso de Uso | Descrição |
94-
| :--- | :--- | :--- |
95-
| `docker compose -f docker-compose.dev.yml build` | **Atualização** | Reconstrói as imagens de desenvolvimento (útil após mudar `package.json`). |
96-
| `docker compose -f docker-compose.prod.yml build` | **Simulação Prod** | Constrói a imagem otimizada de produção. |
101+
| Comando | Caso de Uso | Descrição |
102+
| :------------------------------------------------ | :----------------- | :------------------------------------------------------------------------- |
103+
| `docker compose -f docker-compose.dev.yml build` | **Atualização** | Reconstrói as imagens de desenvolvimento (útil após mudar `package.json`). |
104+
| `docker compose -f docker-compose.prod.yml build` | **Simulação Prod** | Constrói a imagem otimizada de produção. |
97105

98106
### Nest CLI (Scaffolding)
99107

100108
Comandos para gerar código boilerplate.
101109

102-
| Comando | Caso de Uso | Descrição |
103-
| :--- | :--- | :--- |
110+
| Comando | Caso de Uso | Descrição |
111+
| :---------------------------- | :--------------- | :------------------------------------------------------------- |
104112
| `nest g resource module/nome` | **Nova Feature** | Cria um novo módulo completo (Controller, Service, DTOs, etc). |
105-
| `nest g module module/nome` | **Estrutura** | Cria apenas o módulo. |
106-
| `nest g service module/nome` | **Lógica** | Cria apenas o service. |
113+
| `nest g module module/nome` | **Estrutura** | Cria apenas o módulo. |
114+
| `nest g service module/nome` | **Lógica** | Cria apenas o service. |
107115

108116
## Roadmap e Checklist
109117

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
"seed": "prisma db seed",
4949
"verify-all": "pnpm lint && pnpm test-all && pnpm build",
5050
"env:setup": "node -e \"const fs = require('fs'); if (!fs.existsSync('.env')) { fs.copyFileSync('.env.dev.example', '.env'); console.log('Arquivo .env criado com sucesso!'); } else { console.log('O arquivo .env já existe.'); }\"",
51-
"dev": "npm run env:setup && docker compose --env-file .env -f docker-compose.dev.yml up --build -d",
51+
"dev": "npm run env:setup && npm run env:setup && docker compose --env-file .env --env-file .env -f docker-compose.dev.yml up --build -d",
5252
"dev:down": "docker compose -f docker-compose.dev.yml down -v"
5353
},
5454
"dependencies": {

0 commit comments

Comments
 (0)