forjajs 1.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/.claude/agents/context-engineer.md +25 -0
- package/.claude/agents/governance.md +32 -0
- package/.claude/agents/marketing.md +24 -0
- package/.claude/agents/orchestrator.md +31 -0
- package/.claude/agents/product.md +26 -0
- package/.claude/agents/sdd-architect.md +34 -0
- package/.claude/settings.json +41 -0
- package/.gemini-instructions.md +87 -0
- package/.github/copilot-instructions.md +87 -0
- package/.memoryrc.json +104 -0
- package/.openai-instructions.md +87 -0
- package/AGENTS.md +132 -0
- package/CHANGELOG.md +106 -0
- package/CONTRIBUTING.md +32 -0
- package/DOC-MAP.md +65 -0
- package/LICENSE +21 -0
- package/README.md +260 -0
- package/bin/create-memory-nest-kit.js +125 -0
- package/bin/forja.mjs +143 -0
- package/bin/init-project.js +612 -0
- package/boilerplates/01-api-rest/README.md +336 -0
- package/boilerplates/01-api-rest/boilerplate.manifest.json +41 -0
- package/boilerplates/02-saas-starter/.env.example +25 -0
- package/boilerplates/02-saas-starter/CHECKLIST-CRIACAO.md +190 -0
- package/boilerplates/02-saas-starter/INFO.md +252 -0
- package/boilerplates/02-saas-starter/QUICK_START.md +194 -0
- package/boilerplates/02-saas-starter/README.md +305 -0
- package/boilerplates/02-saas-starter/START-HERE.md +259 -0
- package/boilerplates/02-saas-starter/backend/package.json +87 -0
- package/boilerplates/02-saas-starter/backend/src/app.module.ts +27 -0
- package/boilerplates/02-saas-starter/backend/src/common/decorators/roles.decorator.ts +3 -0
- package/boilerplates/02-saas-starter/backend/src/common/decorators/tenant.decorator.ts +6 -0
- package/boilerplates/02-saas-starter/backend/src/common/middleware/roles.guard.ts +23 -0
- package/boilerplates/02-saas-starter/backend/src/config/database.ts +26 -0
- package/boilerplates/02-saas-starter/backend/src/main.ts +26 -0
- package/boilerplates/02-saas-starter/backend/src/modules/auth/auth.controller.ts +46 -0
- package/boilerplates/02-saas-starter/backend/src/modules/auth/auth.module.ts +25 -0
- package/boilerplates/02-saas-starter/backend/src/modules/auth/auth.service.ts +145 -0
- package/boilerplates/02-saas-starter/backend/src/modules/auth/dto/auth.dto.ts +30 -0
- package/boilerplates/02-saas-starter/backend/src/modules/auth/strategies/jwt.strategy.ts +24 -0
- package/boilerplates/02-saas-starter/backend/src/modules/auth/strategies/local.strategy.ts +19 -0
- package/boilerplates/02-saas-starter/backend/src/modules/billing/billing.controller.ts +42 -0
- package/boilerplates/02-saas-starter/backend/src/modules/billing/billing.module.ts +13 -0
- package/boilerplates/02-saas-starter/backend/src/modules/billing/billing.service.ts +67 -0
- package/boilerplates/02-saas-starter/backend/src/modules/billing/entities/invoice.entity.ts +52 -0
- package/boilerplates/02-saas-starter/backend/src/modules/organizations/entities/organization.entity.ts +36 -0
- package/boilerplates/02-saas-starter/backend/src/modules/organizations/organizations.controller.ts +16 -0
- package/boilerplates/02-saas-starter/backend/src/modules/organizations/organizations.module.ts +13 -0
- package/boilerplates/02-saas-starter/backend/src/modules/organizations/organizations.service.ts +34 -0
- package/boilerplates/02-saas-starter/backend/src/modules/subscriptions/entities/subscription.entity.ts +40 -0
- package/boilerplates/02-saas-starter/backend/src/modules/subscriptions/subscriptions.controller.ts +36 -0
- package/boilerplates/02-saas-starter/backend/src/modules/subscriptions/subscriptions.module.ts +13 -0
- package/boilerplates/02-saas-starter/backend/src/modules/subscriptions/subscriptions.service.ts +91 -0
- package/boilerplates/02-saas-starter/backend/src/modules/users/entities/user.entity.ts +42 -0
- package/boilerplates/02-saas-starter/backend/src/modules/users/users.controller.ts +14 -0
- package/boilerplates/02-saas-starter/backend/src/modules/users/users.module.ts +13 -0
- package/boilerplates/02-saas-starter/backend/src/modules/users/users.service.ts +48 -0
- package/boilerplates/02-saas-starter/backend/tsconfig.json +28 -0
- package/boilerplates/02-saas-starter/boilerplate.manifest.json +42 -0
- package/boilerplates/02-saas-starter/docker-compose.yml +34 -0
- package/boilerplates/02-saas-starter/memory/00-global/agent-contract.md +227 -0
- package/boilerplates/02-saas-starter/memory/00-global/context-policy.md +141 -0
- package/boilerplates/02-saas-starter/memory/00-global/index.md +133 -0
- package/boilerplates/02-saas-starter/memory/00-global/mission.md +45 -0
- package/boilerplates/02-saas-starter/memory/00-global/patterns.md +223 -0
- package/boilerplates/02-saas-starter/memory/10-product/business-rules.md +240 -0
- package/boilerplates/02-saas-starter/memory/10-product/nfrs.md +239 -0
- package/boilerplates/02-saas-starter/memory/10-product/personas.md +195 -0
- package/boilerplates/02-saas-starter/memory/10-product/vision.md +63 -0
- package/boilerplates/02-saas-starter/memory/20-architecture/overview.md +232 -0
- package/boilerplates/02-saas-starter/memory/30-domains/auth/api.md +186 -0
- package/boilerplates/02-saas-starter/memory/30-domains/auth/context.md +85 -0
- package/boilerplates/02-saas-starter/memory/30-domains/billing/api.md +262 -0
- package/boilerplates/02-saas-starter/memory/30-domains/billing/context.md +137 -0
- package/boilerplates/02-saas-starter/memory/30-domains/subscriptions/api.md +176 -0
- package/boilerplates/02-saas-starter/memory/30-domains/subscriptions/context.md +100 -0
- package/boilerplates/02-saas-starter/memory/40-delivery/backlog.md +81 -0
- package/boilerplates/02-saas-starter/memory/40-delivery/roadmap.md +97 -0
- package/boilerplates/02-saas-starter/memory/40-delivery/sprint-atual.md +57 -0
- package/boilerplates/02-saas-starter/memory/50-orchestration/topology.md +90 -0
- package/boilerplates/02-saas-starter/memory/60-runs/index.md +54 -0
- package/boilerplates/02-saas-starter/memory/70-summaries/global.md +50 -0
- package/boilerplates/02-saas-starter/memory/80-data/schema.md +185 -0
- package/boilerplates/02-saas-starter/memory/90-decisions/adr-template.md +75 -0
- package/boilerplates/03-ecommerce-starter/FLOW_EXEMPLOS.md +599 -0
- package/boilerplates/03-ecommerce-starter/GUIA_RAPIDO.md +322 -0
- package/boilerplates/03-ecommerce-starter/MANIFEST.md +463 -0
- package/boilerplates/03-ecommerce-starter/README.md +465 -0
- package/boilerplates/03-ecommerce-starter/agents/.gitkeep +0 -0
- package/boilerplates/03-ecommerce-starter/backend/.env.example +121 -0
- package/boilerplates/03-ecommerce-starter/backend/Dockerfile +15 -0
- package/boilerplates/03-ecommerce-starter/backend/docker-compose.yml +56 -0
- package/boilerplates/03-ecommerce-starter/backend/jest.config.js +16 -0
- package/boilerplates/03-ecommerce-starter/backend/package.json +71 -0
- package/boilerplates/03-ecommerce-starter/backend/src/app.controller.ts +12 -0
- package/boilerplates/03-ecommerce-starter/backend/src/app.module.ts +48 -0
- package/boilerplates/03-ecommerce-starter/backend/src/app.service.ts +12 -0
- package/boilerplates/03-ecommerce-starter/backend/src/common/.gitkeep +0 -0
- package/boilerplates/03-ecommerce-starter/backend/src/main.ts +51 -0
- package/boilerplates/03-ecommerce-starter/backend/src/modules/auth/auth.module.ts +8 -0
- package/boilerplates/03-ecommerce-starter/backend/src/modules/cart/cart.module.ts +8 -0
- package/boilerplates/03-ecommerce-starter/backend/src/modules/coupons/coupons.module.ts +8 -0
- package/boilerplates/03-ecommerce-starter/backend/src/modules/inventory/inventory.module.ts +8 -0
- package/boilerplates/03-ecommerce-starter/backend/src/modules/orders/orders.module.ts +10 -0
- package/boilerplates/03-ecommerce-starter/backend/src/modules/payments/payments.module.ts +8 -0
- package/boilerplates/03-ecommerce-starter/backend/src/modules/products/dto/create-product.dto.ts +34 -0
- package/boilerplates/03-ecommerce-starter/backend/src/modules/products/entities/category.entity.ts +47 -0
- package/boilerplates/03-ecommerce-starter/backend/src/modules/products/entities/product.entity.ts +66 -0
- package/boilerplates/03-ecommerce-starter/backend/src/modules/products/products.controller.ts +78 -0
- package/boilerplates/03-ecommerce-starter/backend/src/modules/products/products.module.ts +14 -0
- package/boilerplates/03-ecommerce-starter/backend/src/modules/products/products.service.ts +112 -0
- package/boilerplates/03-ecommerce-starter/backend/src/modules/reviews/entities/review.entity.ts +32 -0
- package/boilerplates/03-ecommerce-starter/backend/src/modules/reviews/reviews.module.ts +11 -0
- package/boilerplates/03-ecommerce-starter/backend/test/health.e2e-spec.ts +31 -0
- package/boilerplates/03-ecommerce-starter/backend/test/jest-e2e.json +12 -0
- package/boilerplates/03-ecommerce-starter/backend/tsconfig.json +23 -0
- package/boilerplates/03-ecommerce-starter/boilerplate.manifest.json +42 -0
- package/boilerplates/03-ecommerce-starter/boilerplate.md +128 -0
- package/boilerplates/03-ecommerce-starter/memory/00-global/agent-contract.md +53 -0
- package/boilerplates/03-ecommerce-starter/memory/00-global/context-index.md +55 -0
- package/boilerplates/03-ecommerce-starter/memory/00-global/context-policy.md +31 -0
- package/boilerplates/03-ecommerce-starter/memory/00-global/mission.md +25 -0
- package/boilerplates/03-ecommerce-starter/memory/00-global/standards.md +45 -0
- package/boilerplates/03-ecommerce-starter/memory/10-product/business-rules.md +62 -0
- package/boilerplates/03-ecommerce-starter/memory/10-product/nfrs.md +62 -0
- package/boilerplates/03-ecommerce-starter/memory/10-product/vision.md +124 -0
- package/boilerplates/03-ecommerce-starter/memory/20-architecture/backend.md +253 -0
- package/boilerplates/03-ecommerce-starter/memory/20-architecture/observability.md +319 -0
- package/boilerplates/03-ecommerce-starter/memory/20-architecture/overview.md +133 -0
- package/boilerplates/03-ecommerce-starter/memory/20-architecture/security.md +227 -0
- package/boilerplates/03-ecommerce-starter/memory/30-domains/catalog/context.md +210 -0
- package/boilerplates/03-ecommerce-starter/memory/30-domains/inventory/context.md +233 -0
- package/boilerplates/03-ecommerce-starter/memory/30-domains/orders/context.md +210 -0
- package/boilerplates/03-ecommerce-starter/memory/30-domains/payments/context.md +168 -0
- package/boilerplates/03-ecommerce-starter/memory/40-delivery/.gitkeep +0 -0
- package/boilerplates/03-ecommerce-starter/memory/50-orchestration/.gitkeep +0 -0
- package/boilerplates/03-ecommerce-starter/memory/60-runs/.gitkeep +0 -0
- package/boilerplates/03-ecommerce-starter/memory/70-summaries/.gitkeep +0 -0
- package/boilerplates/03-ecommerce-starter/memory/80-data/.gitkeep +0 -0
- package/boilerplates/03-ecommerce-starter/memory/80-data/sqlite.md +260 -0
- package/boilerplates/03-ecommerce-starter/memory/90-decisions/.gitkeep +0 -0
- package/boilerplates/03-ecommerce-starter/memory/90-decisions/ADR-TEMPLATE.md +223 -0
- package/boilerplates/03-ecommerce-starter/prompts/.gitkeep +0 -0
- package/boilerplates/03-ecommerce-starter/skills/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/.env.example +43 -0
- package/boilerplates/04-microservices-starter/API-EXAMPLES.md +609 -0
- package/boilerplates/04-microservices-starter/ARCHITECTURE.md +512 -0
- package/boilerplates/04-microservices-starter/GETTING-STARTED.md +246 -0
- package/boilerplates/04-microservices-starter/INDEX.md +377 -0
- package/boilerplates/04-microservices-starter/MANIFEST.md +456 -0
- package/boilerplates/04-microservices-starter/README.md +466 -0
- package/boilerplates/04-microservices-starter/SUMMARY.md +386 -0
- package/boilerplates/04-microservices-starter/backend/api-gateway/Dockerfile +14 -0
- package/boilerplates/04-microservices-starter/backend/api-gateway/package.json +29 -0
- package/boilerplates/04-microservices-starter/backend/api-gateway/src/app.module.ts +9 -0
- package/boilerplates/04-microservices-starter/backend/api-gateway/src/gateway.controller.ts +45 -0
- package/boilerplates/04-microservices-starter/backend/api-gateway/src/gateway.service.ts +114 -0
- package/boilerplates/04-microservices-starter/backend/api-gateway/src/main.ts +9 -0
- package/boilerplates/04-microservices-starter/backend/api-gateway/test/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/backend/api-gateway/tsconfig.json +20 -0
- package/boilerplates/04-microservices-starter/backend/services/auth-service/Dockerfile +14 -0
- package/boilerplates/04-microservices-starter/backend/services/auth-service/package.json +42 -0
- package/boilerplates/04-microservices-starter/backend/services/auth-service/src/app.module.ts +7 -0
- package/boilerplates/04-microservices-starter/backend/services/auth-service/src/main.ts +9 -0
- package/boilerplates/04-microservices-starter/backend/services/auth-service/src/modules/auth/auth.controller.ts +130 -0
- package/boilerplates/04-microservices-starter/backend/services/auth-service/src/modules/auth/auth.module.ts +21 -0
- package/boilerplates/04-microservices-starter/backend/services/auth-service/src/modules/auth/auth.service.ts +159 -0
- package/boilerplates/04-microservices-starter/backend/services/auth-service/src/modules/auth/jwt.strategy.ts +19 -0
- package/boilerplates/04-microservices-starter/backend/services/auth-service/src/modules/auth/local.strategy.ts +18 -0
- package/boilerplates/04-microservices-starter/backend/services/auth-service/src/modules/notification/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/backend/services/auth-service/src/modules/user/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/backend/services/auth-service/test/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/backend/services/auth-service/tsconfig.json +21 -0
- package/boilerplates/04-microservices-starter/backend/services/notification-service/Dockerfile +14 -0
- package/boilerplates/04-microservices-starter/backend/services/notification-service/package.json +25 -0
- package/boilerplates/04-microservices-starter/backend/services/notification-service/src/app.module.ts +7 -0
- package/boilerplates/04-microservices-starter/backend/services/notification-service/src/main.ts +9 -0
- package/boilerplates/04-microservices-starter/backend/services/notification-service/src/modules/auth/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/backend/services/notification-service/src/modules/notification/notification.controller.ts +160 -0
- package/boilerplates/04-microservices-starter/backend/services/notification-service/src/modules/notification/notification.module.ts +10 -0
- package/boilerplates/04-microservices-starter/backend/services/notification-service/src/modules/notification/notification.service.ts +92 -0
- package/boilerplates/04-microservices-starter/backend/services/notification-service/src/modules/user/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/backend/services/notification-service/test/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/backend/services/notification-service/tsconfig.json +20 -0
- package/boilerplates/04-microservices-starter/backend/services/user-service/Dockerfile +14 -0
- package/boilerplates/04-microservices-starter/backend/services/user-service/package.json +25 -0
- package/boilerplates/04-microservices-starter/backend/services/user-service/src/app.module.ts +7 -0
- package/boilerplates/04-microservices-starter/backend/services/user-service/src/main.ts +9 -0
- package/boilerplates/04-microservices-starter/backend/services/user-service/src/modules/auth/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/backend/services/user-service/src/modules/notification/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/backend/services/user-service/src/modules/user/user.controller.ts +122 -0
- package/boilerplates/04-microservices-starter/backend/services/user-service/src/modules/user/user.module.ts +10 -0
- package/boilerplates/04-microservices-starter/backend/services/user-service/src/modules/user/user.service.ts +161 -0
- package/boilerplates/04-microservices-starter/backend/services/user-service/test/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/backend/services/user-service/tsconfig.json +20 -0
- package/boilerplates/04-microservices-starter/backend/shared/package.json +15 -0
- package/boilerplates/04-microservices-starter/backend/shared/src/constants/index.ts +84 -0
- package/boilerplates/04-microservices-starter/backend/shared/src/decorators/index.ts +12 -0
- package/boilerplates/04-microservices-starter/backend/shared/src/index.ts +4 -0
- package/boilerplates/04-microservices-starter/backend/shared/src/interfaces/index.ts +152 -0
- package/boilerplates/04-microservices-starter/backend/shared/src/types/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/backend/shared/src/utils/index.ts +54 -0
- package/boilerplates/04-microservices-starter/backend/shared/tsconfig.json +20 -0
- package/boilerplates/04-microservices-starter/boilerplate.manifest.json +41 -0
- package/boilerplates/04-microservices-starter/docker-compose.yml +164 -0
- package/boilerplates/04-microservices-starter/memory/00-global/agent-contract.md +171 -0
- package/boilerplates/04-microservices-starter/memory/00-global/context-policy.md +89 -0
- package/boilerplates/04-microservices-starter/memory/00-global/index.md +102 -0
- package/boilerplates/04-microservices-starter/memory/00-global/mission.md +44 -0
- package/boilerplates/04-microservices-starter/memory/00-global/patterns.md +106 -0
- package/boilerplates/04-microservices-starter/memory/10-product/vision.md +76 -0
- package/boilerplates/04-microservices-starter/memory/20-architecture/overview.md +247 -0
- package/boilerplates/04-microservices-starter/memory/30-domains/auth-service/api.md +293 -0
- package/boilerplates/04-microservices-starter/memory/30-domains/auth-service/context.md +108 -0
- package/boilerplates/04-microservices-starter/memory/30-domains/notification-service/api.md +333 -0
- package/boilerplates/04-microservices-starter/memory/30-domains/notification-service/context.md +121 -0
- package/boilerplates/04-microservices-starter/memory/30-domains/user-service/api.md +308 -0
- package/boilerplates/04-microservices-starter/memory/30-domains/user-service/context.md +120 -0
- package/boilerplates/04-microservices-starter/memory/40-delivery/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/memory/50-orchestration/topology.md +216 -0
- package/boilerplates/04-microservices-starter/memory/60-runs/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/memory/70-summaries/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/memory/80-data/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/memory/90-decisions/.gitkeep +0 -0
- package/boilerplates/04-microservices-starter/package.json +21 -0
- package/boilerplates/05-monorepo-starter/.env.example +1 -0
- package/boilerplates/05-monorepo-starter/BOILERPLATE_SUMMARY.md +193 -0
- package/boilerplates/05-monorepo-starter/DEVELOPMENT.md +481 -0
- package/boilerplates/05-monorepo-starter/Dockerfile +35 -0
- package/boilerplates/05-monorepo-starter/README.md +318 -0
- package/boilerplates/05-monorepo-starter/boilerplate.manifest.json +43 -0
- package/boilerplates/05-monorepo-starter/docker-compose.yml +36 -0
- package/boilerplates/05-monorepo-starter/memory/00-global/agent-contract.md +28 -0
- package/boilerplates/05-monorepo-starter/memory/00-global/context-policy.md +21 -0
- package/boilerplates/05-monorepo-starter/memory/00-global/index.md +44 -0
- package/boilerplates/05-monorepo-starter/memory/00-global/mission.md +17 -0
- package/boilerplates/05-monorepo-starter/memory/00-global/patterns.md +48 -0
- package/boilerplates/05-monorepo-starter/memory/10-product/business-rules.md +24 -0
- package/boilerplates/05-monorepo-starter/memory/10-product/nfrs.md +39 -0
- package/boilerplates/05-monorepo-starter/memory/10-product/personas.md +25 -0
- package/boilerplates/05-monorepo-starter/memory/10-product/vision.md +22 -0
- package/boilerplates/05-monorepo-starter/memory/20-architecture/backend.md +85 -0
- package/boilerplates/05-monorepo-starter/memory/20-architecture/data.md +66 -0
- package/boilerplates/05-monorepo-starter/memory/20-architecture/frontend.md +58 -0
- package/boilerplates/05-monorepo-starter/memory/20-architecture/overview.md +86 -0
- package/boilerplates/05-monorepo-starter/memory/20-architecture/security.md +58 -0
- package/boilerplates/05-monorepo-starter/memory/30-domains/order/api.md +81 -0
- package/boilerplates/05-monorepo-starter/memory/30-domains/order/context.md +63 -0
- package/boilerplates/05-monorepo-starter/memory/30-domains/product/api.md +81 -0
- package/boilerplates/05-monorepo-starter/memory/30-domains/product/context.md +56 -0
- package/boilerplates/05-monorepo-starter/memory/30-domains/user/api.md +99 -0
- package/boilerplates/05-monorepo-starter/memory/30-domains/user/context.md +58 -0
- package/boilerplates/05-monorepo-starter/memory/40-delivery/.gitkeep +0 -0
- package/boilerplates/05-monorepo-starter/memory/50-orchestration/.gitkeep +0 -0
- package/boilerplates/05-monorepo-starter/memory/60-runs/.gitkeep +0 -0
- package/boilerplates/05-monorepo-starter/memory/70-summaries/.gitkeep +0 -0
- package/boilerplates/05-monorepo-starter/memory/80-data/.gitkeep +0 -0
- package/boilerplates/05-monorepo-starter/memory/90-decisions/.gitkeep +0 -0
- package/boilerplates/05-monorepo-starter/package.json +30 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/.env.example +15 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/README.md +28 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/package.json +53 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/app.module.ts +40 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/common/exceptions/global.exception.ts +32 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/common/guards/jwt.guard.ts +5 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/common/guards/jwt.strategy.ts +11 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/common/guards/roles.guard.ts +17 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/common/health.controller.ts +13 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/main.ts +28 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/modules/orders/dto/index.ts +23 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/modules/orders/entities/order.entity.ts +48 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/modules/orders/orders.controller.ts +51 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/modules/orders/orders.module.ts +13 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/modules/orders/orders.service.ts +123 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/modules/products/dto/index.ts +35 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/modules/products/entities/product.entity.ts +28 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/modules/products/products.controller.ts +49 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/modules/products/products.module.ts +12 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/modules/products/products.service.ts +79 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/modules/users/dto/index.ts +24 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/modules/users/entities/user.entity.ts +28 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/modules/users/users.controller.ts +29 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/modules/users/users.module.ts +15 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/src/modules/users/users.service.ts +78 -0
- package/boilerplates/05-monorepo-starter/packages/apps/backend/tsconfig.json +25 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/.env.example +1 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/README.md +30 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/app/dashboard/page.tsx +39 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/app/layout.tsx +15 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/app/page.tsx +47 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/app/products/page.tsx +51 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/components/features/product-card.tsx +19 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/components/layout/footer.tsx +10 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/components/layout/header.tsx +24 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/components/layout/layout.tsx +13 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/lib/api-client.ts +34 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/lib/auth.ts +35 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/lib/orders.ts +28 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/lib/products.ts +28 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/next.config.js +15 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/package.json +31 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/postcss.config.js +3 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/styles/globals.css +7 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/tailwind.config.js +7 -0
- package/boilerplates/05-monorepo-starter/packages/apps/frontend/tsconfig.json +14 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-types/README.md +35 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-types/package.json +17 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-types/src/api/common.ts +18 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-types/src/api/order.ts +38 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-types/src/api/product.ts +33 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-types/src/api/user.ts +32 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-types/src/domain/index.ts +41 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-types/src/errors/index.ts +46 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-types/src/index.ts +7 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-types/tsconfig.json +8 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-utils/README.md +30 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-utils/package.json +17 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-utils/src/constants/index.ts +45 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-utils/src/index.ts +4 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-utils/src/utils/index.ts +3 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-utils/src/utils/math.ts +30 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-utils/src/utils/string.ts +48 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-utils/src/validators/index.ts +44 -0
- package/boilerplates/05-monorepo-starter/packages/packages/shared-utils/tsconfig.json +8 -0
- package/boilerplates/05-monorepo-starter/tsconfig.json +23 -0
- package/boilerplates/05-monorepo-starter/turbo.json +35 -0
- package/boilerplates/README.md +407 -0
- package/design-md/BRIEF-TEMPLATE.md +47 -0
- package/design-md/INDEX.md +35 -0
- package/design-md/MATRIX.md +24 -0
- package/design-md/PLAYBOOK.md +35 -0
- package/design-md/examples/agent-console-brief.md +48 -0
- package/docs/GUIA-ONBOARDING-EXECUTIVO.md +63 -0
- package/docs/GUIA-ONBOARDING-OPERACIONAL-PAPEIS.md +136 -0
- package/docs/GUIA-ONBOARDING-PROJETO.md +279 -0
- package/docs/agent-harnesses.md +122 -0
- package/docs/archive/CHECKLIST-FINAL.md +295 -0
- package/docs/archive/FASE2-SUMMARY.md +263 -0
- package/docs/archive/FASE3-PROGRESS.md +355 -0
- package/docs/archive/IMPLEMENTACAO-FASE1.md +476 -0
- package/docs/archive/INDICE-MASTER.md +282 -0
- package/docs/archive/PROJETO-COMPLETO.md +363 -0
- package/docs/archive/README-REFINAMENTO.md +293 -0
- package/docs/archive/REFERENCIA-RAPIDA.md +324 -0
- package/docs/archive/REFINAMENTO-v1.0.md +565 -0
- package/docs/archive/RELATORIO-TESTES-INTEGRACAO.md +223 -0
- package/docs/archive/START-HERE.md +319 -0
- package/docs/archive/SUMARIO-EXECUTIVO.md +268 -0
- package/docs/archive/examples/v1/AGENTS.md +10 -0
- package/docs/archive/examples/v1/README.md +36 -0
- package/docs/archive/examples/v1/backend/jest-e2e.json +9 -0
- package/docs/archive/examples/v1/backend/nest-cli.json +4 -0
- package/docs/archive/examples/v1/backend/package.json +42 -0
- package/docs/archive/examples/v1/backend/src/app.controller.ts +12 -0
- package/docs/archive/examples/v1/backend/src/app.module.ts +10 -0
- package/docs/archive/examples/v1/backend/src/app.service.ts +8 -0
- package/docs/archive/examples/v1/backend/src/main.ts +10 -0
- package/docs/archive/examples/v1/backend/test/app.e2e-spec.ts +24 -0
- package/docs/archive/examples/v1/backend/tsconfig.build.json +4 -0
- package/docs/archive/examples/v1/backend/tsconfig.json +17 -0
- package/docs/archive/examples/v1/docs/.gitkeep +0 -0
- package/docs/archive/examples/v1/memory/00-global/glossary.md +5 -0
- package/docs/archive/examples/v1/memory/00-global/mission.md +9 -0
- package/docs/archive/examples/v1/memory/00-global/standards.md +12 -0
- package/docs/archive/examples/v1/memory/00-global/tooling.md +10 -0
- package/docs/archive/examples/v1/memory/10-product/business-rules.md +3 -0
- package/docs/archive/examples/v1/memory/10-product/nfrs.md +6 -0
- package/docs/archive/examples/v1/memory/10-product/personas.md +3 -0
- package/docs/archive/examples/v1/memory/10-product/vision.md +3 -0
- package/docs/archive/examples/v1/memory/20-architecture/backend.md +10 -0
- package/docs/archive/examples/v1/memory/20-architecture/data.md +3 -0
- package/docs/archive/examples/v1/memory/20-architecture/frontend.md +3 -0
- package/docs/archive/examples/v1/memory/20-architecture/observability.md +5 -0
- package/docs/archive/examples/v1/memory/20-architecture/security.md +6 -0
- package/docs/archive/examples/v1/memory/20-architecture/system-overview.md +3 -0
- package/docs/archive/examples/v1/memory/30-domains/auth/api.md +3 -0
- package/docs/archive/examples/v1/memory/30-domains/auth/context.md +3 -0
- package/docs/archive/examples/v1/memory/30-domains/auth/rules.md +3 -0
- package/docs/archive/examples/v1/memory/30-domains/billing/api.md +3 -0
- package/docs/archive/examples/v1/memory/30-domains/billing/context.md +3 -0
- package/docs/archive/examples/v1/memory/30-domains/billing/rules.md +3 -0
- package/docs/archive/examples/v1/memory/30-domains/shared/.gitkeep +0 -0
- package/docs/archive/examples/v1/memory/40-delivery/backlog.md +3 -0
- package/docs/archive/examples/v1/memory/40-delivery/current-sprint.md +10 -0
- package/docs/archive/examples/v1/memory/40-delivery/roadmap.md +3 -0
- package/docs/archive/examples/v1/memory/90-decisions/ADR-0001-template.md +9 -0
- package/docs/archive/examples/v1/memory/90-decisions/archive/.gitkeep +0 -0
- package/docs/archive/examples/v1/prompts/project-prompt-base.md +19 -0
- package/docs/archive/examples/v1/scripts/.gitkeep +0 -0
- package/docs/archive/examples/v2/.memoryrc.json +8 -0
- package/docs/archive/examples/v2/AGENTS.md +16 -0
- package/docs/archive/examples/v2/README.md +35 -0
- package/docs/archive/examples/v2/agents/README.md +3 -0
- package/docs/archive/examples/v2/agents/backend-nest.md +9 -0
- package/docs/archive/examples/v2/agents/dba.md +4 -0
- package/docs/archive/examples/v2/agents/frontend.md +4 -0
- package/docs/archive/examples/v2/agents/orchestrator.md +9 -0
- package/docs/archive/examples/v2/agents/reviewer.md +6 -0
- package/docs/archive/examples/v2/agents/security.md +4 -0
- package/docs/archive/examples/v2/backend/jest-e2e.json +9 -0
- package/docs/archive/examples/v2/backend/nest-cli.json +4 -0
- package/docs/archive/examples/v2/backend/package.json +42 -0
- package/docs/archive/examples/v2/backend/src/app.controller.ts +12 -0
- package/docs/archive/examples/v2/backend/src/app.module.ts +10 -0
- package/docs/archive/examples/v2/backend/src/app.service.ts +8 -0
- package/docs/archive/examples/v2/backend/src/main.ts +10 -0
- package/docs/archive/examples/v2/backend/test/app.e2e-spec.ts +24 -0
- package/docs/archive/examples/v2/backend/tsconfig.build.json +4 -0
- package/docs/archive/examples/v2/backend/tsconfig.json +17 -0
- package/docs/archive/examples/v2/docs/.gitkeep +0 -0
- package/docs/archive/examples/v2/memory/00-global/agent-contract.md +15 -0
- package/docs/archive/examples/v2/memory/00-global/context-index.md +12 -0
- package/docs/archive/examples/v2/memory/00-global/context-policy.md +14 -0
- package/docs/archive/examples/v2/memory/00-global/mission.md +9 -0
- package/docs/archive/examples/v2/memory/00-global/standards.md +12 -0
- package/docs/archive/examples/v2/memory/10-product/business-rules.md +3 -0
- package/docs/archive/examples/v2/memory/10-product/nfrs.md +6 -0
- package/docs/archive/examples/v2/memory/10-product/personas.md +3 -0
- package/docs/archive/examples/v2/memory/10-product/vision.md +3 -0
- package/docs/archive/examples/v2/memory/20-architecture/backend.md +10 -0
- package/docs/archive/examples/v2/memory/20-architecture/data.md +3 -0
- package/docs/archive/examples/v2/memory/20-architecture/frontend.md +3 -0
- package/docs/archive/examples/v2/memory/20-architecture/observability.md +5 -0
- package/docs/archive/examples/v2/memory/20-architecture/security.md +6 -0
- package/docs/archive/examples/v2/memory/20-architecture/system-overview.md +3 -0
- package/docs/archive/examples/v2/memory/30-domains/auth/api.md +3 -0
- package/docs/archive/examples/v2/memory/30-domains/auth/context.md +3 -0
- package/docs/archive/examples/v2/memory/30-domains/auth/rules.md +3 -0
- package/docs/archive/examples/v2/memory/30-domains/billing/api.md +3 -0
- package/docs/archive/examples/v2/memory/30-domains/billing/context.md +3 -0
- package/docs/archive/examples/v2/memory/30-domains/billing/rules.md +3 -0
- package/docs/archive/examples/v2/memory/30-domains/shared/.gitkeep +0 -0
- package/docs/archive/examples/v2/memory/40-delivery/backlog.md +3 -0
- package/docs/archive/examples/v2/memory/40-delivery/current-sprint.md +10 -0
- package/docs/archive/examples/v2/memory/40-delivery/roadmap.md +3 -0
- package/docs/archive/examples/v2/memory/50-orchestration/handoff-protocol.md +8 -0
- package/docs/archive/examples/v2/memory/50-orchestration/handoffs/2026-04-18T18-40-10.517Z_orchestrator_para_backend-nest.md +19 -0
- package/docs/archive/examples/v2/memory/50-orchestration/handoffs/README.md +4 -0
- package/docs/archive/examples/v2/memory/50-orchestration/parallel-playbook.md +9 -0
- package/docs/archive/examples/v2/memory/50-orchestration/routing.md +10 -0
- package/docs/archive/examples/v2/memory/50-orchestration/topology.md +15 -0
- package/docs/archive/examples/v2/memory/60-runs/README.md +3 -0
- package/docs/archive/examples/v2/memory/70-summaries/domain-summary.md +3 -0
- package/docs/archive/examples/v2/memory/70-summaries/global-summary.md +6 -0
- package/docs/archive/examples/v2/memory/90-decisions/ADR-0001-template.md +9 -0
- package/docs/archive/examples/v2/memory/90-decisions/archive/.gitkeep +0 -0
- package/docs/archive/examples/v2/memory/README.md +8 -0
- package/docs/archive/examples/v2/prompts/multi-agent-orchestrator.md +12 -0
- package/docs/archive/examples/v2/prompts/project-prompt-base.md +21 -0
- package/docs/archive/examples/v2/prompts/worker-task-template.md +10 -0
- package/docs/archive/examples/v2/scripts/.gitkeep +0 -0
- package/docs/archive/examples/v2/scripts/append-handoff.mjs +25 -0
- package/docs/archive/examples/v2/scripts/build-context-pack.mjs +31 -0
- package/docs/archive/examples/v2/skills/context-compaction/SKILL.md +9 -0
- package/docs/archive/examples/v2/skills/handoff/SKILL.md +8 -0
- package/docs/archive/examples/v2/skills/nest-api/SKILL.md +7 -0
- package/docs/archive/examples/v2/skills/triage-task/SKILL.md +10 -0
- package/docs/archive/legacy-bin/create-memory-nest-kit-monolith.js +1486 -0
- package/docs/capacidades-externas.md +70 -0
- package/docs/cli-first-operacao.md +74 -0
- package/docs/dashboard.md +102 -0
- package/docs/dev-workflow.md +421 -0
- package/docs/examples.md +546 -0
- package/docs/fluxo.md +103 -0
- package/docs/glossary.md +453 -0
- package/docs/init-project.md +457 -0
- package/docs/manual-operacional-cli-sdd-gsd.md +1014 -0
- package/docs/personas/architect/README.md +333 -0
- package/docs/personas/developer/README.md +371 -0
- package/docs/personas/executive/README.md +172 -0
- package/docs/personas/qa/README.md +350 -0
- package/docs/processo-projeto.md +138 -0
- package/docs/publishing.md +377 -0
- package/docs/quick-reference.md +409 -0
- package/docs/structure.md +360 -0
- package/docs/token-optimization.md +494 -0
- package/lib/context-builder.js +257 -0
- package/lib/core/registry.mjs +284 -0
- package/lib/generators/memory-generator.js +844 -0
- package/lib/generators/nest-generator.js +496 -0
- package/lib/generators/readme-generator.js +213 -0
- package/lib/templates/harness/code-intel.mjs +119 -0
- package/lib/templates/harness/mcp.json +10 -0
- package/lib/utils/file-helpers.js +40 -0
- package/lib/validators/structure-validator.js +253 -0
- package/lib/workspace.mjs +213 -0
- package/memory/00-global/mission.md +15 -0
- package/memory/00-global/shared-knowledge.md +8 -0
- package/memory/00-global/standards.md +47 -0
- package/memory/10-product/personas.md +21 -0
- package/memory/10-product/vision.md +27 -0
- package/memory/30-projects/README.md +15 -0
- package/memory/40-delivery/backlog.md +15 -0
- package/memory/40-delivery/current-sprint.md +21 -0
- package/memory/50-orchestration/gsd-harness.md +55 -0
- package/memory/90-decisions/0001-memoria-hierarquica.md +38 -0
- package/memory/90-decisions/0002-sqlite-fts5-busca.md +25 -0
- package/memory/90-decisions/0003-smart-context-3-modos.md +31 -0
- package/memory/90-decisions/0004-validacao-obrigatoria-nest.md +27 -0
- package/memory/90-decisions/0005-handoff-7-campos.md +32 -0
- package/memory/90-decisions/0006-docs-por-persona.md +23 -0
- package/memory/90-decisions/0007-sdd-pipeline.md +33 -0
- package/memory/90-decisions/0008-sub-agents-claude-handoff-sqlite.md +36 -0
- package/memory/90-decisions/0009-claude-hooks-token-economy.md +43 -0
- package/memory/90-decisions/0010-banco-postgres.md +30 -0
- package/memory/90-decisions/0011-adrs-de-produto-realocadas.md +19 -0
- package/memory/90-decisions/0016-integracao-capacidades-externas.md +64 -0
- package/memory/90-decisions/0017-codegraph-no-harness-gsd.md +40 -0
- package/memory/90-decisions/0018-ferramentas-de-processo.md +46 -0
- package/memory/90-decisions/0019-workspace-separado.md +45 -0
- package/memory/90-decisions/0020-forja-core-cli-unica.md +45 -0
- package/memory/90-decisions/_template.md +28 -0
- package/package.json +107 -0
- package/prompts/context-engineer-agent.md +19 -0
- package/prompts/governance-agent.md +15 -0
- package/prompts/marketing-agent.md +13 -0
- package/prompts/orchestrator-agent.md +18 -0
- package/prompts/product-agent.md +13 -0
- package/prompts/sdd-architect-agent.md +20 -0
- package/scripts/agent-harness.mjs +578 -0
- package/scripts/agent-router.mjs +189 -0
- package/scripts/build-smart-context.js +87 -0
- package/scripts/check-standards.js +98 -0
- package/scripts/compress-memory.mjs +198 -0
- package/scripts/compress-project-memory.js +58 -0
- package/scripts/context-ops.mjs +463 -0
- package/scripts/dev.mjs +349 -0
- package/scripts/extract-global-knowledge.js +52 -0
- package/scripts/generate-dashboard.js +59 -0
- package/scripts/hook-session-start.mjs +70 -0
- package/scripts/hook-user-prompt.mjs +185 -0
- package/scripts/memory-schema.mjs +68 -0
- package/scripts/pre-commit.sh +102 -0
- package/scripts/query-universal-memory.js +50 -0
- package/scripts/spec-cli.mjs +193 -0
- package/scripts/sprint-manager.js +200 -0
- package/scripts/sync-universal-memory.js +278 -0
- package/scripts/token-benchmark.mjs +203 -0
- package/scripts/tools-doctor.mjs +77 -0
- package/specs/README.md +70 -0
- package/specs/_templates/plan.md +43 -0
- package/specs/_templates/spec.md +43 -0
- package/specs/_templates/tasks.md +32 -0
- package/specs/agent-dashboard/plan.md +165 -0
- package/specs/agent-dashboard/spec.md +89 -0
- package/specs/agent-dashboard/tasks.md +168 -0
- package/specs/cli-first-operacao/plan.md +53 -0
- package/specs/cli-first-operacao/spec.md +53 -0
- package/specs/cli-first-operacao/tasks.md +53 -0
- package/specs/dev-token-assets-db/plan.md +71 -0
- package/specs/dev-token-assets-db/spec.md +58 -0
- package/specs/dev-token-assets-db/tasks.md +58 -0
- package/specs/forja-core/spec.md +71 -0
- package/specs/harness-codegraph/spec.md +71 -0
- package/specs/pipeline-sdd-e-orquestracao/spec.md +61 -0
- package/specs/reestruturacao-forja-v2/plan.md +95 -0
- package/specs/reestruturacao-forja-v2/spec.md +70 -0
- package/specs/reestruturacao-forja-v2/tasks.md +113 -0
|
@@ -0,0 +1,318 @@
|
|
|
1
|
+
# Monorepo Starter
|
|
2
|
+
|
|
3
|
+
A production-ready full-stack monorepo template with **Next.js 14** frontend, **NestJS 10** backend, and shared TypeScript packages managed with **Turborepo**.
|
|
4
|
+
|
|
5
|
+
## 🎯 Features
|
|
6
|
+
|
|
7
|
+
- ✅ **Monorepo Structure** — Single repository with frontend, backend, and shared packages
|
|
8
|
+
- ✅ **Type-Safe APIs** — Shared TypeScript types across frontend and backend
|
|
9
|
+
- ✅ **Fast Builds** — Turborepo with intelligent caching
|
|
10
|
+
- ✅ **Zero-Friction Dev** — One command to start everything (`npm run dev`)
|
|
11
|
+
- ✅ **Production Ready** — Docker support, environment config, error handling
|
|
12
|
+
- ✅ **Scalable** — Easy to add new packages and domains
|
|
13
|
+
|
|
14
|
+
## 📦 Packages
|
|
15
|
+
|
|
16
|
+
### Apps
|
|
17
|
+
- **frontend** — Next.js 14 + React 18 + Tailwind CSS
|
|
18
|
+
- Pages: Home, Products, Dashboard
|
|
19
|
+
- API client with JWT auth
|
|
20
|
+
- Server Components by default
|
|
21
|
+
|
|
22
|
+
- **backend** — NestJS 10 + TypeORM + PostgreSQL
|
|
23
|
+
- Modules: Users, Products, Orders
|
|
24
|
+
- JWT authentication with Passport
|
|
25
|
+
- Global error handling
|
|
26
|
+
|
|
27
|
+
### Shared
|
|
28
|
+
- **shared-types** — TypeScript interfaces for API contracts
|
|
29
|
+
- API DTOs (requests/responses)
|
|
30
|
+
- Domain entities
|
|
31
|
+
- Error types
|
|
32
|
+
|
|
33
|
+
- **shared-utils** — Common utilities and helpers
|
|
34
|
+
- Validators (email, password, etc.)
|
|
35
|
+
- String utils (slugify, formatPrice, etc.)
|
|
36
|
+
- Math utils (calculations)
|
|
37
|
+
- Constants
|
|
38
|
+
|
|
39
|
+
## 🚀 Quick Start
|
|
40
|
+
|
|
41
|
+
### Prerequisites
|
|
42
|
+
- Node.js 18+
|
|
43
|
+
- npm 9+
|
|
44
|
+
- Docker & Docker Compose (for database/redis)
|
|
45
|
+
|
|
46
|
+
### 1. Clone and Install
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
cd boilerplates/05-monorepo-starter
|
|
50
|
+
npm install
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### 2. Setup Database
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
# Start PostgreSQL and Redis
|
|
57
|
+
docker-compose up -d
|
|
58
|
+
|
|
59
|
+
# Create .env file in backend
|
|
60
|
+
cp packages/apps/backend/.env.example packages/apps/backend/.env
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### 3. Run Development Mode
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
# Start frontend + backend + watch mode (from root)
|
|
67
|
+
npm run dev
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
- Frontend: http://localhost:3000
|
|
71
|
+
- Backend: http://localhost:3001/api
|
|
72
|
+
- Health check: http://localhost:3001/api/health
|
|
73
|
+
|
|
74
|
+
## 📂 Project Structure
|
|
75
|
+
|
|
76
|
+
```
|
|
77
|
+
monorepo/
|
|
78
|
+
├── packages/
|
|
79
|
+
│ ├── apps/
|
|
80
|
+
│ │ ├── frontend/ # Next.js 14
|
|
81
|
+
│ │ │ ├── app/ # App Router pages
|
|
82
|
+
│ │ │ ├── components/ # React components
|
|
83
|
+
│ │ │ ├── lib/ # API client, hooks
|
|
84
|
+
│ │ │ └── styles/ # Tailwind CSS
|
|
85
|
+
│ │ └── backend/ # NestJS 10
|
|
86
|
+
│ │ └── src/
|
|
87
|
+
│ │ ├── modules/ # Users, Products, Orders
|
|
88
|
+
│ │ └── common/ # Guards, pipes, exceptions
|
|
89
|
+
│ └── packages/
|
|
90
|
+
│ ├── shared-types/ # DTO & domain interfaces
|
|
91
|
+
│ └── shared-utils/ # Utilities & helpers
|
|
92
|
+
├── turbo.json # Turborepo configuration
|
|
93
|
+
├── tsconfig.json # Base TypeScript config
|
|
94
|
+
├── package.json # Workspace root
|
|
95
|
+
├── docker-compose.yml # PostgreSQL + Redis
|
|
96
|
+
└── Dockerfile # Multi-stage production build
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
## 🔧 Commands
|
|
100
|
+
|
|
101
|
+
### Root Level
|
|
102
|
+
```bash
|
|
103
|
+
npm run dev # Start frontend + backend (watch mode)
|
|
104
|
+
npm run build # Build all packages
|
|
105
|
+
npm run test # Run tests
|
|
106
|
+
npm run lint # Lint all packages
|
|
107
|
+
npm run type-check # TypeScript type checking
|
|
108
|
+
npm run clean # Remove build artifacts
|
|
109
|
+
npm run format # Format code with Prettier
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
### Frontend
|
|
113
|
+
```bash
|
|
114
|
+
cd packages/apps/frontend
|
|
115
|
+
npm run dev # Start Next.js dev server
|
|
116
|
+
npm run build # Build for production
|
|
117
|
+
npm run start # Start production server
|
|
118
|
+
npm run lint # Lint code
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
### Backend
|
|
122
|
+
```bash
|
|
123
|
+
cd packages/apps/backend
|
|
124
|
+
npm run dev # Start NestJS dev server (watch)
|
|
125
|
+
npm run build # Build for production
|
|
126
|
+
npm run start # Start production server
|
|
127
|
+
npm run test # Run tests
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
### Shared Packages
|
|
131
|
+
```bash
|
|
132
|
+
cd packages/packages/shared-types
|
|
133
|
+
npm run build # Build TypeScript types
|
|
134
|
+
npm run type-check # Check types
|
|
135
|
+
|
|
136
|
+
cd packages/packages/shared-utils
|
|
137
|
+
npm run build # Build utilities
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
## 🔐 Authentication
|
|
141
|
+
|
|
142
|
+
### JWT Flow
|
|
143
|
+
1. User registers → Backend generates password hash
|
|
144
|
+
2. User logs in → Backend returns JWT token
|
|
145
|
+
3. Frontend stores token in localStorage
|
|
146
|
+
4. Frontend sends token in `Authorization: Bearer <token>` header
|
|
147
|
+
5. Backend JwtGuard validates token on protected routes
|
|
148
|
+
|
|
149
|
+
### Environment Variables
|
|
150
|
+
Create `.env` files:
|
|
151
|
+
|
|
152
|
+
**Frontend** (`packages/apps/frontend/.env.local`):
|
|
153
|
+
```
|
|
154
|
+
NEXT_PUBLIC_API_URL=http://localhost:3001/api
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
**Backend** (`packages/apps/backend/.env`):
|
|
158
|
+
```
|
|
159
|
+
NODE_ENV=development
|
|
160
|
+
PORT=3001
|
|
161
|
+
DB_HOST=localhost
|
|
162
|
+
DB_PORT=5432
|
|
163
|
+
DB_USER=postgres
|
|
164
|
+
DB_PASSWORD=postgres
|
|
165
|
+
DB_NAME=monorepo
|
|
166
|
+
JWT_SECRET=super-secret-key-change-in-production
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
## 📡 API Endpoints
|
|
170
|
+
|
|
171
|
+
### Users
|
|
172
|
+
- `POST /api/users/register` — Create account
|
|
173
|
+
- `POST /api/users/login` — Login
|
|
174
|
+
- `GET /api/users/:id` — Get profile (auth required)
|
|
175
|
+
|
|
176
|
+
### Products
|
|
177
|
+
- `GET /api/products` — List products (paginated)
|
|
178
|
+
- `GET /api/products/:id` — Get product details
|
|
179
|
+
- `POST /api/products` — Create (auth required)
|
|
180
|
+
- `PUT /api/products/:id` — Update (auth required)
|
|
181
|
+
- `DELETE /api/products/:id` — Delete (auth required)
|
|
182
|
+
|
|
183
|
+
### Orders
|
|
184
|
+
- `POST /api/orders` — Create order (auth required)
|
|
185
|
+
- `GET /api/orders` — List user's orders (auth required)
|
|
186
|
+
- `GET /api/orders/:id` — Get order details (auth required)
|
|
187
|
+
- `PATCH /api/orders/:id/status` — Update status (auth required)
|
|
188
|
+
- `DELETE /api/orders/:id` — Cancel order (auth required)
|
|
189
|
+
|
|
190
|
+
## 🏗️ Adding New Features
|
|
191
|
+
|
|
192
|
+
### Add a New Shared Type
|
|
193
|
+
```typescript
|
|
194
|
+
// packages/packages/shared-types/src/api/my-feature.ts
|
|
195
|
+
export interface MyFeatureRequest { ... }
|
|
196
|
+
export interface MyFeatureResponse { ... }
|
|
197
|
+
|
|
198
|
+
// packages/packages/shared-types/src/index.ts (add export)
|
|
199
|
+
export * from './api/my-feature';
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
### Add a New Backend Module
|
|
203
|
+
```bash
|
|
204
|
+
# Create module structure
|
|
205
|
+
mkdir -p packages/apps/backend/src/modules/my-module/{entities,dto}
|
|
206
|
+
|
|
207
|
+
# Create entity, service, controller, module
|
|
208
|
+
# Import in AppModule
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
### Add a New Frontend Page
|
|
212
|
+
```bash
|
|
213
|
+
# Create page directory
|
|
214
|
+
mkdir -p packages/apps/frontend/app/my-page
|
|
215
|
+
|
|
216
|
+
# Create page.tsx with 'use client' for interactivity
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
## 🐳 Docker
|
|
220
|
+
|
|
221
|
+
### Run with Docker Compose
|
|
222
|
+
```bash
|
|
223
|
+
# Start services (postgres + redis)
|
|
224
|
+
docker-compose up -d
|
|
225
|
+
|
|
226
|
+
# Stop services
|
|
227
|
+
docker-compose down
|
|
228
|
+
|
|
229
|
+
# View logs
|
|
230
|
+
docker-compose logs -f
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
### Build Docker Image
|
|
234
|
+
```bash
|
|
235
|
+
docker build -t monorepo-starter .
|
|
236
|
+
docker run -p 3000:3000 -p 3001:3001 monorepo-starter
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
## 🧪 Testing
|
|
240
|
+
|
|
241
|
+
```bash
|
|
242
|
+
# Run all tests
|
|
243
|
+
npm run test
|
|
244
|
+
|
|
245
|
+
# Watch mode
|
|
246
|
+
npm run test:watch
|
|
247
|
+
|
|
248
|
+
# Specific package
|
|
249
|
+
npm run test --workspace=backend
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
## 🚢 Production Deployment
|
|
253
|
+
|
|
254
|
+
1. Set environment variables in production
|
|
255
|
+
2. Build: `npm run build`
|
|
256
|
+
3. Start: `npm run start`
|
|
257
|
+
4. Or use Docker: `docker build -t my-app . && docker run my-app`
|
|
258
|
+
|
|
259
|
+
## 📚 Tech Stack
|
|
260
|
+
|
|
261
|
+
| Layer | Technology | Version |
|
|
262
|
+
|-------|-----------|---------|
|
|
263
|
+
| **Frontend** | Next.js | 14+ |
|
|
264
|
+
| **Frontend UI** | React | 18+ |
|
|
265
|
+
| **Styling** | Tailwind CSS | 3+ |
|
|
266
|
+
| **Backend** | NestJS | 10+ |
|
|
267
|
+
| **Database ORM** | TypeORM | 0.3+ |
|
|
268
|
+
| **Database** | PostgreSQL | 16+ |
|
|
269
|
+
| **Cache** | Redis | 7+ |
|
|
270
|
+
| **Auth** | JWT + Passport | - |
|
|
271
|
+
| **Language** | TypeScript | 5.3+ |
|
|
272
|
+
| **Build** | Turborepo | 1.10+ |
|
|
273
|
+
| **Package Manager** | npm | 9+ |
|
|
274
|
+
|
|
275
|
+
## 📖 Documentation
|
|
276
|
+
|
|
277
|
+
- See `DEVELOPMENT.md` for detailed development guide
|
|
278
|
+
- See `memory/` for architecture decisions and domain documentation
|
|
279
|
+
- See individual `README.md` in each package
|
|
280
|
+
|
|
281
|
+
## 🤝 Contributing
|
|
282
|
+
|
|
283
|
+
1. Create feature branch
|
|
284
|
+
2. Make changes
|
|
285
|
+
3. Run tests and linting: `npm run test && npm run lint`
|
|
286
|
+
4. Type-check: `npm run type-check`
|
|
287
|
+
5. Create pull request
|
|
288
|
+
|
|
289
|
+
## 📝 License
|
|
290
|
+
|
|
291
|
+
MIT - Feel free to use this template for your projects!
|
|
292
|
+
|
|
293
|
+
## 🆘 Troubleshooting
|
|
294
|
+
|
|
295
|
+
**Port already in use?**
|
|
296
|
+
```bash
|
|
297
|
+
# Change ports in .env files or run on different ports
|
|
298
|
+
PORT=3002 npm run dev
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
**TypeScript errors?**
|
|
302
|
+
```bash
|
|
303
|
+
# Rebuild types from shared packages
|
|
304
|
+
npm run build --workspace=shared-types
|
|
305
|
+
npm run build --workspace=shared-utils
|
|
306
|
+
```
|
|
307
|
+
|
|
308
|
+
**Database connection errors?**
|
|
309
|
+
```bash
|
|
310
|
+
# Ensure PostgreSQL is running
|
|
311
|
+
docker-compose up -d postgres
|
|
312
|
+
|
|
313
|
+
# Check connection string in .env
|
|
314
|
+
```
|
|
315
|
+
|
|
316
|
+
---
|
|
317
|
+
|
|
318
|
+
**Happy coding! 🚀**
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
{
|
|
2
|
+
"schemaVersion": "1.0",
|
|
3
|
+
"type": "boilerplate",
|
|
4
|
+
"name": "05-monorepo-starter",
|
|
5
|
+
"title": "Monorepo Starter",
|
|
6
|
+
"path": "boilerplates/05-monorepo-starter",
|
|
7
|
+
"readme": "boilerplates/05-monorepo-starter/README.md",
|
|
8
|
+
"stack": [
|
|
9
|
+
"NestJS",
|
|
10
|
+
"Next.js",
|
|
11
|
+
"React",
|
|
12
|
+
"Docker",
|
|
13
|
+
"Turborepo",
|
|
14
|
+
"JWT",
|
|
15
|
+
"Postgres"
|
|
16
|
+
],
|
|
17
|
+
"useCases": [
|
|
18
|
+
"Monorepo",
|
|
19
|
+
"Dashboard",
|
|
20
|
+
"Auth"
|
|
21
|
+
],
|
|
22
|
+
"commands": [
|
|
23
|
+
"npm install",
|
|
24
|
+
"docker compose up -d",
|
|
25
|
+
"npm test"
|
|
26
|
+
],
|
|
27
|
+
"gates": [
|
|
28
|
+
"npm run spec:check",
|
|
29
|
+
"npm test",
|
|
30
|
+
"npm run project:check"
|
|
31
|
+
],
|
|
32
|
+
"tokenPolicy": {
|
|
33
|
+
"firstRead": [
|
|
34
|
+
"boilerplate.manifest.json",
|
|
35
|
+
"README.md"
|
|
36
|
+
],
|
|
37
|
+
"avoidLoadingByDefault": [
|
|
38
|
+
"node_modules",
|
|
39
|
+
"dist",
|
|
40
|
+
"coverage"
|
|
41
|
+
]
|
|
42
|
+
}
|
|
43
|
+
}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
version: '3.9'
|
|
2
|
+
|
|
3
|
+
services:
|
|
4
|
+
postgres:
|
|
5
|
+
image: postgres:16-alpine
|
|
6
|
+
container_name: monorepo-postgres
|
|
7
|
+
environment:
|
|
8
|
+
POSTGRES_USER: postgres
|
|
9
|
+
POSTGRES_PASSWORD: postgres
|
|
10
|
+
POSTGRES_DB: monorepo
|
|
11
|
+
ports:
|
|
12
|
+
- "5432:5432"
|
|
13
|
+
volumes:
|
|
14
|
+
- postgres_data:/var/lib/postgresql/data
|
|
15
|
+
healthcheck:
|
|
16
|
+
test: ["CMD-SHELL", "pg_isready -U postgres"]
|
|
17
|
+
interval: 10s
|
|
18
|
+
timeout: 5s
|
|
19
|
+
retries: 5
|
|
20
|
+
|
|
21
|
+
redis:
|
|
22
|
+
image: redis:7-alpine
|
|
23
|
+
container_name: monorepo-redis
|
|
24
|
+
ports:
|
|
25
|
+
- "6379:6379"
|
|
26
|
+
volumes:
|
|
27
|
+
- redis_data:/data
|
|
28
|
+
healthcheck:
|
|
29
|
+
test: ["CMD", "redis-cli", "ping"]
|
|
30
|
+
interval: 10s
|
|
31
|
+
timeout: 5s
|
|
32
|
+
retries: 5
|
|
33
|
+
|
|
34
|
+
volumes:
|
|
35
|
+
postgres_data:
|
|
36
|
+
redis_data:
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Agent Contract
|
|
2
|
+
|
|
3
|
+
## Architect Agent
|
|
4
|
+
Manages monorepo structure, dependency graph, and cross-cutting concerns.
|
|
5
|
+
- Tasks: Adding new packages, domain organization
|
|
6
|
+
- Tools: Turborepo config, tsconfig inheritance
|
|
7
|
+
|
|
8
|
+
## Frontend Agent
|
|
9
|
+
Owns Next.js app, components, and UI logic.
|
|
10
|
+
- Tasks: Building pages, components, form handling
|
|
11
|
+
- Imports: shared-types for API contracts, shared-utils for helpers
|
|
12
|
+
- Constraint: Never directly access backend code
|
|
13
|
+
|
|
14
|
+
## Backend Agent
|
|
15
|
+
Owns NestJS modules, business logic, and database.
|
|
16
|
+
- Tasks: API endpoints, domain models, database schemas
|
|
17
|
+
- Imports: shared-types for API contracts, shared-utils for helpers
|
|
18
|
+
- Constraint: Never directly couple to frontend
|
|
19
|
+
|
|
20
|
+
## DevOps Agent
|
|
21
|
+
Manages Docker, deployment, and CI/CD.
|
|
22
|
+
- Tasks: Docker builds, env config, deployment pipelines
|
|
23
|
+
- Focus: Multi-stage builds, Turborepo caching
|
|
24
|
+
|
|
25
|
+
## Integration Points
|
|
26
|
+
- All agents use shared-types for API contracts
|
|
27
|
+
- All agents use shared-utils for common utilities
|
|
28
|
+
- No direct imports between frontend and backend
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Context Policy
|
|
2
|
+
|
|
3
|
+
## Local Development
|
|
4
|
+
- Root `npm run dev` starts frontend + backend + watchers
|
|
5
|
+
- Environment: `.env.local` for secrets, `.env.example` for docs
|
|
6
|
+
- Database: PostgreSQL + Redis via docker-compose
|
|
7
|
+
|
|
8
|
+
## Build & Deployment
|
|
9
|
+
- Turborepo caches builds and tests
|
|
10
|
+
- `npm run build` builds all packages in dependency order
|
|
11
|
+
- Docker multi-stage builds (frontend + backend in one image if needed)
|
|
12
|
+
|
|
13
|
+
## Git Workflow
|
|
14
|
+
- Monorepo uses conventional commits
|
|
15
|
+
- CI/CD runs Turborepo affected checks
|
|
16
|
+
- Shared code changes trigger dependent tests
|
|
17
|
+
|
|
18
|
+
## Code Review
|
|
19
|
+
- Shared-types changes require +2 approval (affects both apps)
|
|
20
|
+
- Domain logic isolated to backend modules
|
|
21
|
+
- UI components isolated to frontend
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Memory Index
|
|
2
|
+
|
|
3
|
+
## 00-global/
|
|
4
|
+
- **mission.md** — Core mission & success criteria
|
|
5
|
+
- **patterns.md** — Monorepo structure & file organization
|
|
6
|
+
- **context-policy.md** — Dev workflow, git, code review
|
|
7
|
+
- **agent-contract.md** — Agent responsibilities & integration points
|
|
8
|
+
- **index.md** (this file) — Navigation
|
|
9
|
+
|
|
10
|
+
## 10-product/
|
|
11
|
+
- **vision.md** — Product vision & core features
|
|
12
|
+
- **personas.md** — User personas
|
|
13
|
+
- **business-rules.md** — Domain constraints
|
|
14
|
+
- **nfrs.md** — Non-functional requirements (performance, security)
|
|
15
|
+
|
|
16
|
+
## 20-architecture/
|
|
17
|
+
- **overview.md** — Monorepo tech stack
|
|
18
|
+
- **frontend.md** — Next.js architecture
|
|
19
|
+
- **backend.md** — NestJS module structure
|
|
20
|
+
- **data.md** — Database design
|
|
21
|
+
- **security.md** — Auth, validation, API security
|
|
22
|
+
|
|
23
|
+
## 30-domains/
|
|
24
|
+
- **user/** — User domain (auth, profile)
|
|
25
|
+
- **product/** — Product domain (catalog, inventory)
|
|
26
|
+
- **order/** — Order domain (shopping, payments)
|
|
27
|
+
|
|
28
|
+
## 40-delivery/
|
|
29
|
+
- Roadmap and sprint planning
|
|
30
|
+
|
|
31
|
+
## 50-orchestration/
|
|
32
|
+
- Handoff protocols, service integration
|
|
33
|
+
|
|
34
|
+
## 60-runs/
|
|
35
|
+
- Execution logs
|
|
36
|
+
|
|
37
|
+
## 70-summaries/
|
|
38
|
+
- Domain & global summaries
|
|
39
|
+
|
|
40
|
+
## 80-data/
|
|
41
|
+
- Database schema docs
|
|
42
|
+
|
|
43
|
+
## 90-decisions/
|
|
44
|
+
- Architecture Decision Records (ADRs)
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Mission & Vision
|
|
2
|
+
|
|
3
|
+
## Core Mission
|
|
4
|
+
Build a scalable, maintainable full-stack monorepo architecture supporting modern web applications with shared business logic and types across frontend and backend.
|
|
5
|
+
|
|
6
|
+
## Success Criteria
|
|
7
|
+
- Single source of truth for API contracts (shared-types)
|
|
8
|
+
- Zero-friction local development (one `npm run dev` command)
|
|
9
|
+
- Production-ready deployment pipeline (Docker, Turborepo cache)
|
|
10
|
+
- Clear boundaries between frontend, backend, and shared packages
|
|
11
|
+
- TypeScript end-to-end type safety
|
|
12
|
+
|
|
13
|
+
## Principles
|
|
14
|
+
1. **Monorepo-first**: Shared code lives in packages/, not duplicate
|
|
15
|
+
2. **Type-safety**: All API contracts defined in shared-types/
|
|
16
|
+
3. **Performance**: Turborepo cache for fast builds
|
|
17
|
+
4. **Scalability**: Easy to add new packages and domains
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# Architectural Patterns
|
|
2
|
+
|
|
3
|
+
## Monorepo Structure
|
|
4
|
+
```
|
|
5
|
+
packages/
|
|
6
|
+
├── apps/
|
|
7
|
+
│ ├── frontend/ # Next.js 14+ (React)
|
|
8
|
+
│ └── backend/ # NestJS 10+
|
|
9
|
+
└── packages/
|
|
10
|
+
├── shared-types/ # API & domain interfaces
|
|
11
|
+
└── shared-utils/ # Utilities & helpers
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Package Interdependencies
|
|
15
|
+
```
|
|
16
|
+
frontend → shared-types ✓
|
|
17
|
+
backend → shared-types ✓
|
|
18
|
+
shared-utils → nothing
|
|
19
|
+
frontend → shared-utils ✓
|
|
20
|
+
backend → shared-utils ✓
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## File Organization
|
|
24
|
+
|
|
25
|
+
### Frontend (Next.js)
|
|
26
|
+
- `/app` — App Router pages & layouts
|
|
27
|
+
- `/components` — React components
|
|
28
|
+
- `/lib` — Utilities, hooks, api client
|
|
29
|
+
- `/public` — Static assets
|
|
30
|
+
|
|
31
|
+
### Backend (NestJS)
|
|
32
|
+
- `/src/modules` — Feature modules (users, products, orders)
|
|
33
|
+
- `/src/common` — Guards, interceptors, pipes
|
|
34
|
+
- `/test` — Integration tests
|
|
35
|
+
|
|
36
|
+
### Shared Packages
|
|
37
|
+
- `/src/api` — Request/response DTOs
|
|
38
|
+
- `/src/domain` — Business entities
|
|
39
|
+
- `/src/errors` — Custom error types
|
|
40
|
+
|
|
41
|
+
## API Contract Pattern
|
|
42
|
+
All API endpoints defined in shared-types/src/api/:
|
|
43
|
+
```typescript
|
|
44
|
+
export interface CreateUserRequest { ... }
|
|
45
|
+
export interface UserResponse { ... }
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Frontend & Backend import from shared-types.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Business Rules
|
|
2
|
+
|
|
3
|
+
## User Domain
|
|
4
|
+
- Users must have unique email
|
|
5
|
+
- Email must be validated before account activation
|
|
6
|
+
- Passwords must be hashed (bcrypt)
|
|
7
|
+
- Users can have multiple roles (admin, user)
|
|
8
|
+
|
|
9
|
+
## Product Domain
|
|
10
|
+
- Products belong to categories
|
|
11
|
+
- Products have inventory levels
|
|
12
|
+
- Prices are in USD (or configurable currency)
|
|
13
|
+
- Products can be soft-deleted (not hard-deleted)
|
|
14
|
+
|
|
15
|
+
## Order Domain
|
|
16
|
+
- Orders can only be created by authenticated users
|
|
17
|
+
- Items in cart expire after 30 minutes if not checked out
|
|
18
|
+
- Orders transition through states: pending → processing → shipped → delivered
|
|
19
|
+
- Refunds allowed within 30 days of delivery
|
|
20
|
+
|
|
21
|
+
## Inventory
|
|
22
|
+
- Stock decreases when order is confirmed
|
|
23
|
+
- Overselling is prevented (stock check before order creation)
|
|
24
|
+
- Stock alerts trigger at 20% of max inventory
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Non-Functional Requirements
|
|
2
|
+
|
|
3
|
+
## Performance
|
|
4
|
+
- Frontend First Contentful Paint < 2s
|
|
5
|
+
- API response times < 200ms (p95)
|
|
6
|
+
- Database queries < 100ms
|
|
7
|
+
- Build time < 30s (with Turborepo cache)
|
|
8
|
+
|
|
9
|
+
## Scalability
|
|
10
|
+
- Support 10k concurrent users
|
|
11
|
+
- Handle 1000 orders/minute during peak
|
|
12
|
+
- Database: Vertical scaling up to 100GB
|
|
13
|
+
|
|
14
|
+
## Security
|
|
15
|
+
- All passwords hashed (bcrypt, >10 rounds)
|
|
16
|
+
- JWT tokens with 24h expiry
|
|
17
|
+
- Refresh tokens stored in secure httpOnly cookies
|
|
18
|
+
- CORS enabled only for trusted origins
|
|
19
|
+
- API rate limiting (100 req/min per IP)
|
|
20
|
+
- SQL injection prevention via ORM/parameterized queries
|
|
21
|
+
- HTTPS enforced in production
|
|
22
|
+
|
|
23
|
+
## Reliability
|
|
24
|
+
- 99.9% uptime SLA
|
|
25
|
+
- Automated backups (daily)
|
|
26
|
+
- Graceful degradation if Redis down
|
|
27
|
+
- Health checks every 30s
|
|
28
|
+
|
|
29
|
+
## Maintainability
|
|
30
|
+
- <20% cyclomatic complexity per function
|
|
31
|
+
- 80%+ test coverage on business logic
|
|
32
|
+
- Shared types reduce API contract bugs
|
|
33
|
+
- Clear module boundaries (no circular dependencies)
|
|
34
|
+
|
|
35
|
+
## Developer Experience
|
|
36
|
+
- Setup time < 5 minutes
|
|
37
|
+
- Hot reload on code changes (frontend + backend)
|
|
38
|
+
- Clear error messages
|
|
39
|
+
- Comprehensive docs
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# User Personas
|
|
2
|
+
|
|
3
|
+
## 1. Alex (Developer)
|
|
4
|
+
- Role: Full-stack engineer onboarding to the project
|
|
5
|
+
- Goals: Quickly understand monorepo structure, add new features
|
|
6
|
+
- Pain Points: Complex boilerplate, unclear boundaries
|
|
7
|
+
- Solution: Clear docs, working examples, shared-types guidance
|
|
8
|
+
|
|
9
|
+
## 2. Sam (Product Manager)
|
|
10
|
+
- Role: Defines features and roadmap
|
|
11
|
+
- Goals: See completed features fast, measure progress
|
|
12
|
+
- Pain Points: Long build times, unclear status
|
|
13
|
+
- Solution: Turborepo cache, CI/CD feedback
|
|
14
|
+
|
|
15
|
+
## 3. Pat (DevOps Engineer)
|
|
16
|
+
- Role: Deployment and infrastructure
|
|
17
|
+
- Goals: Simple build/deploy pipeline, environment consistency
|
|
18
|
+
- Pain Points: Multi-service deployment complexity
|
|
19
|
+
- Solution: Docker multi-stage builds, docker-compose, Turborepo
|
|
20
|
+
|
|
21
|
+
## 4. Casey (End User)
|
|
22
|
+
- Role: Shops on the platform
|
|
23
|
+
- Goals: Browse products, create orders, track purchases
|
|
24
|
+
- Pain Points: Slow site, poor UX
|
|
25
|
+
- Solution: Fast Next.js frontend, smooth interactions
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Product Vision
|
|
2
|
+
|
|
3
|
+
## Core Value Proposition
|
|
4
|
+
A modern, scalable e-commerce platform built with a full-stack monorepo enabling rapid feature development and seamless collaboration between frontend and backend teams.
|
|
5
|
+
|
|
6
|
+
## Primary Features
|
|
7
|
+
1. **User Management** — Registration, authentication, profiles
|
|
8
|
+
2. **Product Catalog** — Browse, search, filter products
|
|
9
|
+
3. **Shopping Cart** — Add/remove items, cart persistence
|
|
10
|
+
4. **Orders** — Create orders, order history, tracking
|
|
11
|
+
5. **Dashboard** — Admin dashboard for analytics
|
|
12
|
+
|
|
13
|
+
## User Journey
|
|
14
|
+
```
|
|
15
|
+
Homepage → Browse Products → Add to Cart → Checkout → Order Confirmation → Dashboard
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Success Metrics
|
|
19
|
+
- Time to first feature deployment
|
|
20
|
+
- Type safety coverage (% of code with TS)
|
|
21
|
+
- Build time (Turborepo cache efficiency)
|
|
22
|
+
- Developer satisfaction (easy to add new features)
|