forjajs 5.0.1 → 5.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +38 -2
- package/README.md +4 -2
- package/README.pt-BR.md +4 -1
- package/boilerplates/02-saas-starter/README.md +58 -293
- package/boilerplates/02-saas-starter/backend/.env.example +13 -0
- package/boilerplates/02-saas-starter/backend/.oxlintrc.json +8 -0
- package/boilerplates/02-saas-starter/backend/nest-cli.json +6 -0
- package/boilerplates/02-saas-starter/backend/package.json +32 -73
- package/boilerplates/02-saas-starter/backend/src/app.module.ts +16 -16
- package/boilerplates/02-saas-starter/backend/src/billing/adapters/http/billing.controller.ts +55 -0
- package/boilerplates/02-saas-starter/backend/src/billing/adapters/persistence/orm-entities.ts +28 -0
- package/boilerplates/02-saas-starter/backend/src/billing/adapters/persistence/typeorm-billing.repository.ts +46 -0
- package/boilerplates/02-saas-starter/backend/src/billing/application/billing.service.spec.ts +58 -0
- package/boilerplates/02-saas-starter/backend/src/billing/application/billing.service.ts +68 -0
- package/boilerplates/02-saas-starter/backend/src/billing/billing.module.ts +11 -0
- package/boilerplates/02-saas-starter/backend/src/billing/domain/plan.spec.ts +23 -0
- package/boilerplates/02-saas-starter/backend/src/billing/domain/plan.ts +36 -0
- package/boilerplates/02-saas-starter/backend/src/billing/domain/ports.ts +27 -0
- package/boilerplates/02-saas-starter/backend/src/billing/domain/subscription.spec.ts +28 -0
- package/boilerplates/02-saas-starter/backend/src/billing/domain/subscription.ts +47 -0
- package/boilerplates/02-saas-starter/backend/src/identity/adapters/http/auth.dto.ts +22 -0
- package/boilerplates/02-saas-starter/backend/src/identity/adapters/http/identity.controller.ts +59 -0
- package/boilerplates/02-saas-starter/backend/src/identity/adapters/persistence/orm-entities.ts +25 -0
- package/boilerplates/02-saas-starter/backend/src/identity/adapters/persistence/typeorm-identity.repository.ts +47 -0
- package/boilerplates/02-saas-starter/backend/src/identity/application/auth.service.spec.ts +72 -0
- package/boilerplates/02-saas-starter/backend/src/identity/application/auth.service.ts +63 -0
- package/boilerplates/02-saas-starter/backend/src/identity/domain/model.spec.ts +19 -0
- package/boilerplates/02-saas-starter/backend/src/identity/domain/model.ts +42 -0
- package/boilerplates/02-saas-starter/backend/src/identity/domain/password.spec.ts +17 -0
- package/boilerplates/02-saas-starter/backend/src/identity/domain/password.ts +26 -0
- package/boilerplates/02-saas-starter/backend/src/identity/identity.module.ts +12 -0
- package/boilerplates/02-saas-starter/backend/src/main.ts +19 -19
- package/boilerplates/02-saas-starter/backend/src/platform/auth/jwt-auth.guard.ts +17 -0
- package/boilerplates/02-saas-starter/backend/src/platform/auth/principal.ts +22 -0
- package/boilerplates/02-saas-starter/backend/src/platform/auth/roles.guard.spec.ts +23 -0
- package/boilerplates/02-saas-starter/backend/src/platform/auth/roles.guard.ts +20 -0
- package/boilerplates/02-saas-starter/backend/src/platform/auth/token.service.ts +54 -0
- package/boilerplates/02-saas-starter/backend/src/platform/config.spec.ts +18 -0
- package/boilerplates/02-saas-starter/backend/src/platform/config.ts +33 -0
- package/boilerplates/02-saas-starter/backend/src/platform/platform.module.ts +14 -0
- package/boilerplates/02-saas-starter/backend/tsconfig.build.json +6 -0
- package/boilerplates/02-saas-starter/backend/tsconfig.json +16 -21
- package/boilerplates/02-saas-starter/backend/vitest.config.ts +7 -0
- package/boilerplates/02-saas-starter/boilerplate.manifest.json +19 -14
- package/boilerplates/02-saas-starter/docker-compose.yml +10 -24
- package/boilerplates/02-saas-starter/memory/30-domains/billing/context.md +15 -132
- package/boilerplates/02-saas-starter/memory/30-domains/identity/context.md +20 -0
- package/boilerplates/README.md +9 -10
- package/dist/bin/init-project.js +1 -0
- package/dist/lib/core/journey.js +10 -0
- package/dist/lib/generators/memory-generator.d.ts +0 -11
- package/dist/lib/generators/memory-generator.js +5 -161
- package/dist/lib/generators/readme-generator.js +1 -1
- package/dist/lib/llm/json-output.d.ts +14 -0
- package/dist/lib/llm/json-output.js +77 -0
- package/dist/lib/project-wiring.d.ts +8 -0
- package/dist/lib/project-wiring.js +74 -2
- package/dist/lib/validators/structure-validator.js +0 -1
- package/dist/packages/llm/src/index.js +12 -2
- package/dist/scripts/llm-fit.js +23 -1
- package/docs/llm-fit-loop.md +16 -0
- package/memory/90-decisions/0088-templates-validados.md +3 -0
- package/memory/90-decisions/0089-skills-do-projeto.md +51 -0
- package/memory/90-decisions/0090-adapters-de-agente-somente-leitura.md +47 -0
- package/package.json +1 -1
- package/specs/skills-do-projeto/plan.md +40 -0
- package/specs/skills-do-projeto/spec.md +63 -0
- package/specs/skills-do-projeto/tasks.md +27 -0
- package/templates/project/AGENTS.md +9 -0
- package/templates/project/agents/context-engineer.md +3 -0
- package/templates/project/agents/governance.md +3 -0
- package/templates/project/agents/marketing.md +3 -0
- package/templates/project/agents/orchestrator.md +3 -0
- package/templates/project/agents/product.md +3 -0
- package/templates/project/agents/sdd-architect.md +3 -0
- package/templates/project/skills/README.md +14 -0
- package/templates/project/skills/accessibility-review/SKILL.md +89 -0
- package/templates/project/skills/api-design/SKILL.md +77 -0
- package/templates/project/skills/architecture-decision-record/SKILL.md +92 -0
- package/templates/project/skills/backlog-slicing/SKILL.md +82 -0
- package/templates/project/skills/bounded-context-mapping/SKILL.md +88 -0
- package/templates/project/skills/ci-pipeline-review/SKILL.md +83 -0
- package/templates/project/skills/commit-message/SKILL.md +143 -0
- package/templates/project/skills/data-migrations/SKILL.md +88 -0
- package/templates/project/skills/dependency-upgrade/SKILL.md +75 -0
- package/templates/project/skills/docker-compose-review/SKILL.md +85 -0
- package/templates/project/skills/domain-modeling/SKILL.md +120 -0
- package/templates/project/skills/event-storming/SKILL.md +95 -0
- package/templates/project/skills/executive-writing/SKILL.md +99 -0
- package/templates/project/skills/frontend-architecture/SKILL.md +97 -0
- package/templates/project/skills/incident-postmortem/SKILL.md +93 -0
- package/templates/project/skills/lgpd-compliance/SKILL.md +108 -0
- package/templates/project/skills/llm-provider-routing/SKILL.md +18 -0
- package/templates/project/skills/observability/SKILL.md +93 -0
- package/templates/project/skills/product-evaluation/SKILL.md +130 -0
- package/templates/project/skills/prompt-spec/SKILL.md +83 -0
- package/templates/project/skills/pull-request/SKILL.md +101 -0
- package/templates/project/skills/query-performance/SKILL.md +83 -0
- package/templates/project/skills/release-checklist/SKILL.md +106 -0
- package/templates/project/skills/release-notes/SKILL.md +87 -0
- package/templates/project/skills/requirements-elicitation/SKILL.md +127 -0
- package/templates/project/skills/requirements-gathering/SKILL.md +134 -0
- package/templates/project/skills/technical-spike/SKILL.md +101 -0
- package/templates/project/skills/testing/SKILL.md +109 -0
- package/templates/project/skills/threat-modeling/SKILL.md +87 -0
- package/templates/project/skills/ts-async-patterns/SKILL.md +101 -0
- package/templates/project/skills/ts-code-review/SKILL.md +121 -0
- package/templates/project/skills/ts-module-layout/SKILL.md +104 -0
- package/templates/project/skills/ts-testing/SKILL.md +89 -0
- package/templates/project/skills/web-performance/SKILL.md +72 -0
- package/boilerplates/02-saas-starter/.env.example +0 -25
- package/boilerplates/02-saas-starter/CHECKLIST-CRIACAO.md +0 -190
- package/boilerplates/02-saas-starter/INFO.md +0 -252
- package/boilerplates/02-saas-starter/QUICK_START.md +0 -194
- package/boilerplates/02-saas-starter/START-HERE.md +0 -259
- package/boilerplates/02-saas-starter/backend/src/common/decorators/roles.decorator.ts +0 -3
- package/boilerplates/02-saas-starter/backend/src/common/decorators/tenant.decorator.ts +0 -6
- package/boilerplates/02-saas-starter/backend/src/common/middleware/roles.guard.ts +0 -23
- package/boilerplates/02-saas-starter/backend/src/config/database.ts +0 -26
- package/boilerplates/02-saas-starter/backend/src/modules/auth/auth.controller.ts +0 -46
- package/boilerplates/02-saas-starter/backend/src/modules/auth/auth.module.ts +0 -25
- package/boilerplates/02-saas-starter/backend/src/modules/auth/auth.service.ts +0 -145
- package/boilerplates/02-saas-starter/backend/src/modules/auth/dto/auth.dto.ts +0 -30
- package/boilerplates/02-saas-starter/backend/src/modules/auth/strategies/jwt.strategy.ts +0 -24
- package/boilerplates/02-saas-starter/backend/src/modules/auth/strategies/local.strategy.ts +0 -19
- package/boilerplates/02-saas-starter/backend/src/modules/billing/billing.controller.ts +0 -42
- package/boilerplates/02-saas-starter/backend/src/modules/billing/billing.module.ts +0 -13
- package/boilerplates/02-saas-starter/backend/src/modules/billing/billing.service.ts +0 -67
- package/boilerplates/02-saas-starter/backend/src/modules/billing/entities/invoice.entity.ts +0 -52
- package/boilerplates/02-saas-starter/backend/src/modules/organizations/entities/organization.entity.ts +0 -36
- package/boilerplates/02-saas-starter/backend/src/modules/organizations/organizations.controller.ts +0 -16
- package/boilerplates/02-saas-starter/backend/src/modules/organizations/organizations.module.ts +0 -13
- package/boilerplates/02-saas-starter/backend/src/modules/organizations/organizations.service.ts +0 -34
- package/boilerplates/02-saas-starter/backend/src/modules/subscriptions/entities/subscription.entity.ts +0 -40
- package/boilerplates/02-saas-starter/backend/src/modules/subscriptions/subscriptions.controller.ts +0 -36
- package/boilerplates/02-saas-starter/backend/src/modules/subscriptions/subscriptions.module.ts +0 -13
- package/boilerplates/02-saas-starter/backend/src/modules/subscriptions/subscriptions.service.ts +0 -91
- package/boilerplates/02-saas-starter/backend/src/modules/users/entities/user.entity.ts +0 -42
- package/boilerplates/02-saas-starter/backend/src/modules/users/users.controller.ts +0 -14
- package/boilerplates/02-saas-starter/backend/src/modules/users/users.module.ts +0 -13
- package/boilerplates/02-saas-starter/backend/src/modules/users/users.service.ts +0 -48
- package/boilerplates/02-saas-starter/memory/00-global/agent-contract.md +0 -227
- package/boilerplates/02-saas-starter/memory/00-global/context-policy.md +0 -141
- package/boilerplates/02-saas-starter/memory/00-global/index.md +0 -133
- package/boilerplates/02-saas-starter/memory/00-global/mission.md +0 -45
- package/boilerplates/02-saas-starter/memory/00-global/patterns.md +0 -223
- package/boilerplates/02-saas-starter/memory/10-product/business-rules.md +0 -240
- package/boilerplates/02-saas-starter/memory/10-product/nfrs.md +0 -239
- package/boilerplates/02-saas-starter/memory/10-product/personas.md +0 -195
- package/boilerplates/02-saas-starter/memory/10-product/vision.md +0 -63
- package/boilerplates/02-saas-starter/memory/20-architecture/overview.md +0 -232
- package/boilerplates/02-saas-starter/memory/30-domains/auth/api.md +0 -186
- package/boilerplates/02-saas-starter/memory/30-domains/auth/context.md +0 -85
- package/boilerplates/02-saas-starter/memory/30-domains/billing/api.md +0 -262
- package/boilerplates/02-saas-starter/memory/30-domains/subscriptions/api.md +0 -176
- package/boilerplates/02-saas-starter/memory/30-domains/subscriptions/context.md +0 -100
- package/boilerplates/02-saas-starter/memory/40-delivery/backlog.md +0 -81
- package/boilerplates/02-saas-starter/memory/40-delivery/roadmap.md +0 -97
- package/boilerplates/02-saas-starter/memory/40-delivery/sprint-atual.md +0 -57
- package/boilerplates/02-saas-starter/memory/50-orchestration/topology.md +0 -90
- package/boilerplates/02-saas-starter/memory/60-runs/index.md +0 -54
- package/boilerplates/02-saas-starter/memory/70-summaries/global.md +0 -50
- package/boilerplates/02-saas-starter/memory/80-data/schema.md +0 -185
- package/boilerplates/02-saas-starter/memory/90-decisions/adr-template.md +0 -75
|
@@ -1,194 +0,0 @@
|
|
|
1
|
-
# SaaS Starter - Quick Start Guide
|
|
2
|
-
|
|
3
|
-
Get your SaaS running in **< 5 minutes**.
|
|
4
|
-
|
|
5
|
-
## Prerequisites
|
|
6
|
-
|
|
7
|
-
- Node.js 18+ LTS
|
|
8
|
-
- Docker & Docker Compose
|
|
9
|
-
- Git
|
|
10
|
-
|
|
11
|
-
## Setup
|
|
12
|
-
|
|
13
|
-
### 1. Clone & Install
|
|
14
|
-
|
|
15
|
-
```bash
|
|
16
|
-
cd boilerplates/02-saas-starter
|
|
17
|
-
npm install
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
### 2. Start Database & Cache
|
|
21
|
-
|
|
22
|
-
```bash
|
|
23
|
-
docker-compose up -d
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
This starts:
|
|
27
|
-
- PostgreSQL on `localhost:5432`
|
|
28
|
-
- Redis on `localhost:6379`
|
|
29
|
-
|
|
30
|
-
### 3. Configure Environment
|
|
31
|
-
|
|
32
|
-
```bash
|
|
33
|
-
cp .env.example .env.local
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
Update `.env.local` with your values (or use defaults for development).
|
|
37
|
-
|
|
38
|
-
### 4. Run Migrations (Future)
|
|
39
|
-
|
|
40
|
-
```bash
|
|
41
|
-
npm run migration:run
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
For now, TypeORM auto-sync creates tables.
|
|
45
|
-
|
|
46
|
-
### 5. Start Server
|
|
47
|
-
|
|
48
|
-
```bash
|
|
49
|
-
npm run start:dev
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
Server runs on `http://localhost:3000`
|
|
53
|
-
|
|
54
|
-
## Test the API
|
|
55
|
-
|
|
56
|
-
### Signup
|
|
57
|
-
|
|
58
|
-
```bash
|
|
59
|
-
curl -X POST http://localhost:3000/api/auth/signup \
|
|
60
|
-
-H "Content-Type: application/json" \
|
|
61
|
-
-d '{
|
|
62
|
-
"email": "founder@example.com",
|
|
63
|
-
"password": "SecureP@ss123",
|
|
64
|
-
"organizationName": "My Startup"
|
|
65
|
-
}'
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
**Response**:
|
|
69
|
-
```json
|
|
70
|
-
{
|
|
71
|
-
"data": {
|
|
72
|
-
"user": { "id": "...", "email": "..." },
|
|
73
|
-
"organization": { "id": "...", "name": "...", "plan": "free" },
|
|
74
|
-
"accessToken": "eyJh...",
|
|
75
|
-
"refreshToken": "eyJh..."
|
|
76
|
-
}
|
|
77
|
-
}
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
### Login
|
|
81
|
-
|
|
82
|
-
```bash
|
|
83
|
-
curl -X POST http://localhost:3000/api/auth/login-email \
|
|
84
|
-
-H "Content-Type: application/json" \
|
|
85
|
-
-d '{
|
|
86
|
-
"email": "founder@example.com",
|
|
87
|
-
"password": "SecureP@ss123"
|
|
88
|
-
}'
|
|
89
|
-
```
|
|
90
|
-
|
|
91
|
-
### Get Current User
|
|
92
|
-
|
|
93
|
-
```bash
|
|
94
|
-
curl -X GET http://localhost:3000/api/auth/me \
|
|
95
|
-
-H "Authorization: Bearer {accessToken}"
|
|
96
|
-
```
|
|
97
|
-
|
|
98
|
-
### Get Subscription
|
|
99
|
-
|
|
100
|
-
```bash
|
|
101
|
-
curl -X GET http://localhost:3000/api/subscriptions \
|
|
102
|
-
-H "Authorization: Bearer {accessToken}"
|
|
103
|
-
```
|
|
104
|
-
|
|
105
|
-
### Upgrade Plan
|
|
106
|
-
|
|
107
|
-
```bash
|
|
108
|
-
curl -X POST http://localhost:3000/api/subscriptions/{id}/upgrade \
|
|
109
|
-
-H "Authorization: Bearer {accessToken}" \
|
|
110
|
-
-H "Content-Type: application/json" \
|
|
111
|
-
-d '{ "newPlan": "pro" }'
|
|
112
|
-
```
|
|
113
|
-
|
|
114
|
-
### Create Invoice (Mock Payment)
|
|
115
|
-
|
|
116
|
-
```bash
|
|
117
|
-
curl -X POST http://localhost:3000/api/billing/charge \
|
|
118
|
-
-H "Authorization: Bearer {accessToken}" \
|
|
119
|
-
-H "Content-Type: application/json" \
|
|
120
|
-
-d '{
|
|
121
|
-
"amount": 99.00,
|
|
122
|
-
"description": "Pro Plan - January 2024"
|
|
123
|
-
}'
|
|
124
|
-
```
|
|
125
|
-
|
|
126
|
-
## Documentation
|
|
127
|
-
|
|
128
|
-
- **API Docs**: http://localhost:3000/api/docs (Swagger)
|
|
129
|
-
- **Architecture**: [memory/20-architecture/overview.md](./memory/20-architecture/overview.md)
|
|
130
|
-
- **Patterns**: [memory/00-global/patterns.md](./memory/00-global/patterns.md)
|
|
131
|
-
- **Database Schema**: [memory/80-data/schema.md](./memory/80-data/schema.md)
|
|
132
|
-
|
|
133
|
-
## Running Tests
|
|
134
|
-
|
|
135
|
-
```bash
|
|
136
|
-
npm run test
|
|
137
|
-
npm run test:cov
|
|
138
|
-
npm run test:e2e
|
|
139
|
-
```
|
|
140
|
-
|
|
141
|
-
## Development Commands
|
|
142
|
-
|
|
143
|
-
```bash
|
|
144
|
-
# Format code
|
|
145
|
-
npm run format
|
|
146
|
-
|
|
147
|
-
# Lint
|
|
148
|
-
npm run lint
|
|
149
|
-
|
|
150
|
-
# Build
|
|
151
|
-
npm run build
|
|
152
|
-
|
|
153
|
-
# Production
|
|
154
|
-
npm run start:prod
|
|
155
|
-
```
|
|
156
|
-
|
|
157
|
-
## Troubleshooting
|
|
158
|
-
|
|
159
|
-
### Port already in use
|
|
160
|
-
|
|
161
|
-
```bash
|
|
162
|
-
lsof -i :3000
|
|
163
|
-
kill -9 {PID}
|
|
164
|
-
```
|
|
165
|
-
|
|
166
|
-
### Database connection failed
|
|
167
|
-
|
|
168
|
-
```bash
|
|
169
|
-
docker-compose ps
|
|
170
|
-
docker-compose logs postgres
|
|
171
|
-
```
|
|
172
|
-
|
|
173
|
-
### Module not found errors
|
|
174
|
-
|
|
175
|
-
```bash
|
|
176
|
-
rm -rf node_modules package-lock.json
|
|
177
|
-
npm install
|
|
178
|
-
```
|
|
179
|
-
|
|
180
|
-
## Next Steps
|
|
181
|
-
|
|
182
|
-
1. **Customize**: Extend modules in `backend/src/modules/`
|
|
183
|
-
2. **Frontend**: Build React/Vue app, consume `/api/` endpoints
|
|
184
|
-
3. **Deploy**: Docker → AWS ECS / Render / Heroku
|
|
185
|
-
4. **Real Payments**: Integrate Stripe (see `memory/30-domains/billing/`)
|
|
186
|
-
5. **Scale**: Add caching, monitoring, observability
|
|
187
|
-
|
|
188
|
-
## Documentation Structure
|
|
189
|
-
|
|
190
|
-
See [memory/00-global/index.md](./memory/00-global/index.md) for navigation.
|
|
191
|
-
|
|
192
|
-
---
|
|
193
|
-
|
|
194
|
-
**Need help?** Check the [Architecture](./memory/20-architecture/overview.md) or [API Specs](./memory/30-domains/auth/api.md).
|
|
@@ -1,259 +0,0 @@
|
|
|
1
|
-
# 🚀 START HERE - SaaS Starter
|
|
2
|
-
|
|
3
|
-
Bem-vindo ao boilerplate SaaS Starter!
|
|
4
|
-
|
|
5
|
-
## ⏱️ 5-Minute Setup
|
|
6
|
-
|
|
7
|
-
```bash
|
|
8
|
-
# 1. Navegar ao projeto
|
|
9
|
-
cd boilerplates/02-saas-starter
|
|
10
|
-
|
|
11
|
-
# 2. Instalar dependências
|
|
12
|
-
npm install
|
|
13
|
-
|
|
14
|
-
# 3. Iniciar banco de dados
|
|
15
|
-
docker-compose up -d
|
|
16
|
-
|
|
17
|
-
# 4. Configurar ambiente
|
|
18
|
-
cp .env.example .env.local
|
|
19
|
-
|
|
20
|
-
# 5. Rodar servidor
|
|
21
|
-
npm run start:dev
|
|
22
|
-
|
|
23
|
-
# ✅ Pronto! Servidor rodando em http://localhost:3000
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
## 🎯 Primeiros Passos
|
|
27
|
-
|
|
28
|
-
### 1. Testar API
|
|
29
|
-
|
|
30
|
-
Abra um novo terminal:
|
|
31
|
-
|
|
32
|
-
```bash
|
|
33
|
-
# Signup (criar usuário + organização)
|
|
34
|
-
curl -X POST http://localhost:3000/api/auth/signup \
|
|
35
|
-
-H "Content-Type: application/json" \
|
|
36
|
-
-d '{
|
|
37
|
-
"email": "founder@example.com",
|
|
38
|
-
"password": "SecureP@ss123",
|
|
39
|
-
"organizationName": "My Startup"
|
|
40
|
-
}'
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
Você receberá:
|
|
44
|
-
```json
|
|
45
|
-
{
|
|
46
|
-
"data": {
|
|
47
|
-
"user": { "id": "...", "email": "founder@example.com" },
|
|
48
|
-
"organization": { "id": "...", "name": "My Startup", "plan": "free" },
|
|
49
|
-
"accessToken": "eyJhbGc...",
|
|
50
|
-
"refreshToken": "eyJhbGc..."
|
|
51
|
-
}
|
|
52
|
-
}
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
Salve o `accessToken` para os próximos passos.
|
|
56
|
-
|
|
57
|
-
### 2. Consultar API Docs
|
|
58
|
-
|
|
59
|
-
Abra no navegador:
|
|
60
|
-
|
|
61
|
-
```
|
|
62
|
-
http://localhost:3000/api/docs
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
Veja todos os endpoints documentados com Swagger.
|
|
66
|
-
|
|
67
|
-
### 3. Testar Upgrade de Plano
|
|
68
|
-
|
|
69
|
-
```bash
|
|
70
|
-
curl -X POST http://localhost:3000/api/subscriptions/{subscription-id}/upgrade \
|
|
71
|
-
-H "Authorization: Bearer {accessToken}" \
|
|
72
|
-
-H "Content-Type: application/json" \
|
|
73
|
-
-d '{ "newPlan": "pro" }'
|
|
74
|
-
```
|
|
75
|
-
|
|
76
|
-
### 4. Processar Pagamento (Mock)
|
|
77
|
-
|
|
78
|
-
```bash
|
|
79
|
-
curl -X POST http://localhost:3000/api/billing/charge \
|
|
80
|
-
-H "Authorization: Bearer {accessToken}" \
|
|
81
|
-
-H "Content-Type: application/json" \
|
|
82
|
-
-d '{
|
|
83
|
-
"amount": 99.00,
|
|
84
|
-
"description": "Pro Plan - January 2024"
|
|
85
|
-
}'
|
|
86
|
-
```
|
|
87
|
-
|
|
88
|
-
Retorna invoice com mock payment (90% sucesso, 10% falha para teste).
|
|
89
|
-
|
|
90
|
-
## 📚 Documentação
|
|
91
|
-
|
|
92
|
-
### Para Começar Rápido
|
|
93
|
-
- **[README.md](./README.md)** — Overview do projeto
|
|
94
|
-
- **[QUICK_START.md](./QUICK_START.md)** — Setup detalhado + troubleshooting
|
|
95
|
-
- **[INFO.md](./INFO.md)** — Informações gerais do projeto
|
|
96
|
-
|
|
97
|
-
### Para Entender o Projeto
|
|
98
|
-
- **[memory/00-global/index.md](./memory/00-global/index.md)** — Índice de toda documentação
|
|
99
|
-
- **[memory/00-global/patterns.md](./memory/00-global/patterns.md)** — Code patterns & conventions
|
|
100
|
-
- **[memory/20-architecture/overview.md](./memory/20-architecture/overview.md)** — Arquitetura completa
|
|
101
|
-
|
|
102
|
-
### Para Usar APIs Específicas
|
|
103
|
-
- **[memory/30-domains/auth/api.md](./memory/30-domains/auth/api.md)** — Auth endpoints
|
|
104
|
-
- **[memory/30-domains/subscriptions/api.md](./memory/30-domains/subscriptions/api.md)** — Subscription endpoints
|
|
105
|
-
- **[memory/30-domains/billing/api.md](./memory/30-domains/billing/api.md)** — Billing endpoints
|
|
106
|
-
|
|
107
|
-
### Para Expandir
|
|
108
|
-
- **[memory/40-delivery/roadmap.md](./memory/40-delivery/roadmap.md)** — 12-month roadmap
|
|
109
|
-
- **[memory/80-data/schema.md](./memory/80-data/schema.md)** — Database schema
|
|
110
|
-
|
|
111
|
-
## 🏗️ Estrutura do Projeto
|
|
112
|
-
|
|
113
|
-
```
|
|
114
|
-
boilerplates/02-saas-starter/
|
|
115
|
-
├── backend/ # NestJS aplicação
|
|
116
|
-
│ ├── src/
|
|
117
|
-
│ │ ├── modules/ # Auth, Users, Organizations, Subscriptions, Billing
|
|
118
|
-
│ │ ├── common/ # Guards, decorators
|
|
119
|
-
│ │ └── config/ # Database, JWT
|
|
120
|
-
│ └── package.json
|
|
121
|
-
├── memory/ # Documentação (10 níveis)
|
|
122
|
-
│ ├── 00-global/ # Mission, patterns, policies
|
|
123
|
-
│ ├── 10-product/ # Vision, personas, rules
|
|
124
|
-
│ ├── 20-architecture/ # Tech decisions
|
|
125
|
-
│ ├── 30-domains/ # Auth, subscriptions, billing
|
|
126
|
-
│ ├── 40-delivery/ # Roadmap, sprints
|
|
127
|
-
│ ├── 50-orchestration/ # Agent topology
|
|
128
|
-
│ ├── 60-runs/ # Execution logs
|
|
129
|
-
│ ├── 70-summaries/ # Executive summaries
|
|
130
|
-
│ ├── 80-data/ # Schema
|
|
131
|
-
│ └── 90-decisions/ # ADRs
|
|
132
|
-
├── docker-compose.yml # Database & cache
|
|
133
|
-
├── .env.example # Environment config
|
|
134
|
-
├── README.md # Project overview
|
|
135
|
-
└── QUICK_START.md # Setup guide
|
|
136
|
-
```
|
|
137
|
-
|
|
138
|
-
## 🔑 Características
|
|
139
|
-
|
|
140
|
-
✅ **Multi-Tenant** — Isolamento seguro de dados
|
|
141
|
-
✅ **JWT Auth** — Autenticação stateless
|
|
142
|
-
✅ **RBAC** — Owner, admin, member roles
|
|
143
|
-
✅ **Subscriptions** — Free, pro, enterprise plans
|
|
144
|
-
✅ **Billing** — Mock Stripe integration
|
|
145
|
-
✅ **TypeScript** — Strict mode, type-safe
|
|
146
|
-
✅ **Well-Documented** — 30+ docs, 10-level memory
|
|
147
|
-
✅ **Production-Ready** — Error handling, validation
|
|
148
|
-
|
|
149
|
-
## 💡 Primeiras Modificações
|
|
150
|
-
|
|
151
|
-
### Adicionar um novo endpoint
|
|
152
|
-
|
|
153
|
-
1. **Criar DTO**
|
|
154
|
-
```typescript
|
|
155
|
-
// backend/src/modules/subscriptions/dto/create-subscription.dto.ts
|
|
156
|
-
export class CreateSubscriptionDto {
|
|
157
|
-
@IsString()
|
|
158
|
-
plan: string;
|
|
159
|
-
}
|
|
160
|
-
```
|
|
161
|
-
|
|
162
|
-
2. **Adicionar ao Service**
|
|
163
|
-
```typescript
|
|
164
|
-
// backend/src/modules/subscriptions/subscriptions.service.ts
|
|
165
|
-
async create(dto: CreateSubscriptionDto) {
|
|
166
|
-
// lógica aqui
|
|
167
|
-
}
|
|
168
|
-
```
|
|
169
|
-
|
|
170
|
-
3. **Expor no Controller**
|
|
171
|
-
```typescript
|
|
172
|
-
// backend/src/modules/subscriptions/subscriptions.controller.ts
|
|
173
|
-
@Post()
|
|
174
|
-
create(@Body() dto: CreateSubscriptionDto) {
|
|
175
|
-
return this.subsService.create(dto);
|
|
176
|
-
}
|
|
177
|
-
```
|
|
178
|
-
|
|
179
|
-
4. **Testar**
|
|
180
|
-
```bash
|
|
181
|
-
npm run test:e2e
|
|
182
|
-
```
|
|
183
|
-
|
|
184
|
-
### Adicionar um novo módulo
|
|
185
|
-
|
|
186
|
-
1. Criar pasta em `backend/src/modules/new-module/`
|
|
187
|
-
2. Criar entity, service, controller, module
|
|
188
|
-
3. Registrar em `backend/src/app.module.ts`
|
|
189
|
-
4. Documentar em `memory/30-domains/new-module/`
|
|
190
|
-
|
|
191
|
-
## 🛠️ Comandos Úteis
|
|
192
|
-
|
|
193
|
-
```bash
|
|
194
|
-
# Desenvolvimento
|
|
195
|
-
npm run start:dev # Hot reload
|
|
196
|
-
npm run format # Format code
|
|
197
|
-
npm run lint # Lint
|
|
198
|
-
|
|
199
|
-
# Testes
|
|
200
|
-
npm run test # Unit tests
|
|
201
|
-
npm run test:cov # Coverage
|
|
202
|
-
npm run test:e2e # E2E tests
|
|
203
|
-
|
|
204
|
-
# Produção
|
|
205
|
-
npm run build # Build
|
|
206
|
-
npm run start:prod # Run production build
|
|
207
|
-
|
|
208
|
-
# Database
|
|
209
|
-
npm run migration:create # Create migration
|
|
210
|
-
npm run migration:run # Run migrations
|
|
211
|
-
```
|
|
212
|
-
|
|
213
|
-
## 🐛 Troubleshooting
|
|
214
|
-
|
|
215
|
-
### Erro: "Port 3000 already in use"
|
|
216
|
-
```bash
|
|
217
|
-
lsof -i :3000
|
|
218
|
-
kill -9 {PID}
|
|
219
|
-
npm run start:dev
|
|
220
|
-
```
|
|
221
|
-
|
|
222
|
-
### Erro: "Cannot connect to database"
|
|
223
|
-
```bash
|
|
224
|
-
docker-compose ps
|
|
225
|
-
docker-compose logs postgres
|
|
226
|
-
docker-compose down && docker-compose up -d
|
|
227
|
-
```
|
|
228
|
-
|
|
229
|
-
### Erro: "Module not found"
|
|
230
|
-
```bash
|
|
231
|
-
rm -rf node_modules package-lock.json
|
|
232
|
-
npm install
|
|
233
|
-
```
|
|
234
|
-
|
|
235
|
-
## 📞 Perguntas?
|
|
236
|
-
|
|
237
|
-
1. Consulte [README.md](./README.md) para overview
|
|
238
|
-
2. Veja [QUICK_START.md](./QUICK_START.md) para setup detalhado
|
|
239
|
-
3. Navegue [memory/00-global/index.md](./memory/00-global/index.md) para índice de docs
|
|
240
|
-
4. Abra http://localhost:3000/api/docs para API docs
|
|
241
|
-
|
|
242
|
-
## 🎓 Próximas Etapas
|
|
243
|
-
|
|
244
|
-
1. ✅ Setup e teste básico (você está aqui)
|
|
245
|
-
2. Explore arquitetura em [memory/20-architecture/](./memory/20-architecture/)
|
|
246
|
-
3. Customize lógica de negócio
|
|
247
|
-
4. Adicione um novo módulo
|
|
248
|
-
5. Deploy em produção
|
|
249
|
-
6. Scale com observability
|
|
250
|
-
|
|
251
|
-
## ✨ Bom desenvolvimento!
|
|
252
|
-
|
|
253
|
-
Este projeto foi desenvolvido para você lançar sua SaaS em semanas, não meses.
|
|
254
|
-
|
|
255
|
-
**Tudo está pronto. Agora é com você! 🚀**
|
|
256
|
-
|
|
257
|
-
---
|
|
258
|
-
|
|
259
|
-
**Precisa de ajuda?** Consulte a documentação completa em [memory/00-global/index.md](./memory/00-global/index.md)
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
import { Injectable, CanActivate, ExecutionContext } from '@nestjs/common';
|
|
2
|
-
import { Reflector } from '@nestjs/core';
|
|
3
|
-
|
|
4
|
-
@Injectable()
|
|
5
|
-
export class RolesGuard implements CanActivate {
|
|
6
|
-
constructor(private reflector: Reflector) {}
|
|
7
|
-
|
|
8
|
-
canActivate(context: ExecutionContext): boolean {
|
|
9
|
-
const requiredRoles = this.reflector.get<string[]>('roles', context.getHandler());
|
|
10
|
-
if (!requiredRoles) {
|
|
11
|
-
return true;
|
|
12
|
-
}
|
|
13
|
-
|
|
14
|
-
const request = context.switchToHttp().getRequest();
|
|
15
|
-
const user = request.user;
|
|
16
|
-
|
|
17
|
-
if (!user || !user.roles) {
|
|
18
|
-
return false;
|
|
19
|
-
}
|
|
20
|
-
|
|
21
|
-
return requiredRoles.some((role) => user.roles.includes(role));
|
|
22
|
-
}
|
|
23
|
-
}
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
import { Injectable } from '@nestjs/common';
|
|
2
|
-
import { TypeOrmModuleOptions, TypeOrmOptionsFactory } from '@nestjs/typeorm';
|
|
3
|
-
import { ConfigService } from '@nestjs/config';
|
|
4
|
-
import { User } from '../modules/users/entities/user.entity';
|
|
5
|
-
import { Organization } from '../modules/organizations/entities/organization.entity';
|
|
6
|
-
import { Subscription } from '../modules/subscriptions/entities/subscription.entity';
|
|
7
|
-
import { Invoice } from '../modules/billing/entities/invoice.entity';
|
|
8
|
-
|
|
9
|
-
@Injectable()
|
|
10
|
-
export class TypeOrmConfigService implements TypeOrmOptionsFactory {
|
|
11
|
-
constructor(private configService: ConfigService) {}
|
|
12
|
-
|
|
13
|
-
createTypeOrmOptions(): TypeOrmModuleOptions {
|
|
14
|
-
return {
|
|
15
|
-
type: 'postgres',
|
|
16
|
-
host: this.configService.get('DB_HOST', 'localhost'),
|
|
17
|
-
port: this.configService.get('DB_PORT', 5432),
|
|
18
|
-
username: this.configService.get('DB_USER', 'postgres'),
|
|
19
|
-
password: this.configService.get('DB_PASSWORD', 'postgres'),
|
|
20
|
-
database: this.configService.get('DB_NAME', 'saas_starter'),
|
|
21
|
-
entities: [User, Organization, Subscription, Invoice],
|
|
22
|
-
synchronize: this.configService.get('NODE_ENV') === 'development',
|
|
23
|
-
logging: this.configService.get('DB_LOGGING') === 'true',
|
|
24
|
-
};
|
|
25
|
-
}
|
|
26
|
-
}
|
|
@@ -1,46 +0,0 @@
|
|
|
1
|
-
import { Controller, Post, Body, UseGuards, Get, UnauthorizedException } from '@nestjs/common';
|
|
2
|
-
import { AuthGuard } from '@nestjs/passport';
|
|
3
|
-
import { AuthService } from './auth.service';
|
|
4
|
-
import { SignupDto, LoginDto, RefreshTokenDto } from './dto/auth.dto';
|
|
5
|
-
|
|
6
|
-
@Controller('auth')
|
|
7
|
-
export class AuthController {
|
|
8
|
-
constructor(private authService: AuthService) {}
|
|
9
|
-
|
|
10
|
-
@Post('signup')
|
|
11
|
-
async signup(@Body() signupDto: SignupDto) {
|
|
12
|
-
const result = await this.authService.signup(signupDto);
|
|
13
|
-
return { data: result };
|
|
14
|
-
}
|
|
15
|
-
|
|
16
|
-
@Post('login')
|
|
17
|
-
@UseGuards(AuthGuard('local'))
|
|
18
|
-
async login(@Body() _loginDto: LoginDto) {
|
|
19
|
-
return { data: 'Use POST /api/auth/login with email & password' };
|
|
20
|
-
}
|
|
21
|
-
|
|
22
|
-
@Post('login-email')
|
|
23
|
-
async loginWithEmail(@Body() loginDto: LoginDto) {
|
|
24
|
-
const result = await this.authService.login(loginDto.email, loginDto.password);
|
|
25
|
-
return { data: result };
|
|
26
|
-
}
|
|
27
|
-
|
|
28
|
-
@Post('refresh')
|
|
29
|
-
async refresh(@Body() refreshTokenDto: RefreshTokenDto) {
|
|
30
|
-
const payload = this.authService.verifyRefreshToken(refreshTokenDto.refreshToken);
|
|
31
|
-
const tokens = this.authService.generateTokens({ ...payload });
|
|
32
|
-
return { data: tokens };
|
|
33
|
-
}
|
|
34
|
-
|
|
35
|
-
@Get('me')
|
|
36
|
-
@UseGuards(AuthGuard('jwt'))
|
|
37
|
-
async getMe(@Body() req: any) {
|
|
38
|
-
return { data: req.user };
|
|
39
|
-
}
|
|
40
|
-
|
|
41
|
-
@Post('logout')
|
|
42
|
-
@UseGuards(AuthGuard('jwt'))
|
|
43
|
-
async logout() {
|
|
44
|
-
return { message: 'Logged out successfully' };
|
|
45
|
-
}
|
|
46
|
-
}
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
import { Module } from '@nestjs/common';
|
|
2
|
-
import { TypeOrmModule } from '@nestjs/typeorm';
|
|
3
|
-
import { JwtModule } from '@nestjs/jwt';
|
|
4
|
-
import { PassportModule } from '@nestjs/passport';
|
|
5
|
-
import { User } from '../users/entities/user.entity';
|
|
6
|
-
import { Organization } from '../organizations/entities/organization.entity';
|
|
7
|
-
import { AuthService } from './auth.service';
|
|
8
|
-
import { AuthController } from './auth.controller';
|
|
9
|
-
import { JwtStrategy } from './strategies/jwt.strategy';
|
|
10
|
-
import { LocalStrategy } from './strategies/local.strategy';
|
|
11
|
-
|
|
12
|
-
@Module({
|
|
13
|
-
imports: [
|
|
14
|
-
TypeOrmModule.forFeature([User, Organization]),
|
|
15
|
-
PassportModule,
|
|
16
|
-
JwtModule.register({
|
|
17
|
-
secret: process.env.JWT_SECRET || 'dev-secret-key',
|
|
18
|
-
signOptions: { expiresIn: '15m' },
|
|
19
|
-
}),
|
|
20
|
-
],
|
|
21
|
-
controllers: [AuthController],
|
|
22
|
-
providers: [AuthService, JwtStrategy, LocalStrategy],
|
|
23
|
-
exports: [AuthService],
|
|
24
|
-
})
|
|
25
|
-
export class AuthModule {}
|