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,246 @@
|
|
|
1
|
+
# 🚀 Getting Started with Microservices Starter
|
|
2
|
+
|
|
3
|
+
## Prerequisites
|
|
4
|
+
- Docker & Docker Compose
|
|
5
|
+
- Node.js 18+ (for local development)
|
|
6
|
+
- npm or yarn
|
|
7
|
+
|
|
8
|
+
## 30-Second Quick Start
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
# Clone/download and enter the directory
|
|
12
|
+
cd boilerplates/04-microservices-starter
|
|
13
|
+
|
|
14
|
+
# Start all services
|
|
15
|
+
docker-compose up
|
|
16
|
+
|
|
17
|
+
# In another terminal, test the API
|
|
18
|
+
curl -X POST http://localhost:3000/auth/login \
|
|
19
|
+
-H "Content-Type: application/json" \
|
|
20
|
+
-d '{"email":"test@example.com","password":"TestPassword123!"}'
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Done! 🎉
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## 📖 What's Running?
|
|
28
|
+
|
|
29
|
+
| Service | Port | Purpose |
|
|
30
|
+
|---------|------|---------|
|
|
31
|
+
| API Gateway | 3000 | Entry point for all requests |
|
|
32
|
+
| Auth Service | 3001 | Login, register, token management |
|
|
33
|
+
| User Service | 3002 | User profiles and settings |
|
|
34
|
+
| Notification Service | 3003 | Email and push notifications |
|
|
35
|
+
| PostgreSQL (Auth) | 5432 | Auth service database |
|
|
36
|
+
| PostgreSQL (User) | 5433 | User service database |
|
|
37
|
+
| RabbitMQ | 5672 | Message queue |
|
|
38
|
+
| RabbitMQ Admin | 15672 | Message queue dashboard |
|
|
39
|
+
| Redis | 6379 | Cache |
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## 🔐 Test Login
|
|
44
|
+
|
|
45
|
+
Use these credentials to log in:
|
|
46
|
+
|
|
47
|
+
```
|
|
48
|
+
Email: test@example.com
|
|
49
|
+
Password: TestPassword123!
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Get JWT Token
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
TOKENS=$(curl -s -X POST http://localhost:3000/auth/login \
|
|
56
|
+
-H "Content-Type: application/json" \
|
|
57
|
+
-d '{"email":"test@example.com","password":"TestPassword123!"}' | jq '.data.tokens')
|
|
58
|
+
|
|
59
|
+
ACCESS_TOKEN=$(echo $TOKENS | jq -r '.accessToken')
|
|
60
|
+
echo $ACCESS_TOKEN
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
## 👤 Create a User Profile
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
curl -X POST http://localhost:3000/users \
|
|
69
|
+
-H "Authorization: Bearer $ACCESS_TOKEN" \
|
|
70
|
+
-H "Content-Type: application/json" \
|
|
71
|
+
-d '{
|
|
72
|
+
"email": "test@example.com",
|
|
73
|
+
"fullName": "Test User",
|
|
74
|
+
"avatar": "https://via.placeholder.com/150"
|
|
75
|
+
}'
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
---
|
|
79
|
+
|
|
80
|
+
## 📧 Send a Notification
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
curl -X POST http://localhost:3000/notifications/email \
|
|
84
|
+
-H "Content-Type: application/json" \
|
|
85
|
+
-d '{
|
|
86
|
+
"userId": "550e8400-e29b-41d4-a716-446655440000",
|
|
87
|
+
"recipient": "test@example.com",
|
|
88
|
+
"subject": "Welcome!",
|
|
89
|
+
"body": "Thanks for testing our platform",
|
|
90
|
+
"template": "welcome_email"
|
|
91
|
+
}'
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
---
|
|
95
|
+
|
|
96
|
+
## 📚 Documentation
|
|
97
|
+
|
|
98
|
+
### Start Here
|
|
99
|
+
1. **[README.md](./README.md)** - Project overview
|
|
100
|
+
2. **[ARCHITECTURE.md](./ARCHITECTURE.md)** - System design
|
|
101
|
+
3. **[API-EXAMPLES.md](./API-EXAMPLES.md)** - API usage examples
|
|
102
|
+
|
|
103
|
+
### Memory System (Knowledge Base)
|
|
104
|
+
The `memory/` folder contains comprehensive documentation:
|
|
105
|
+
|
|
106
|
+
- **[mission.md](./memory/00-global/mission.md)** - Vision and goals
|
|
107
|
+
- **[patterns.md](./memory/00-global/patterns.md)** - Architectural patterns
|
|
108
|
+
- **[overview.md](./memory/20-architecture/overview.md)** - Architecture details
|
|
109
|
+
- **[topology.md](./memory/50-orchestration/topology.md)** - Service topology
|
|
110
|
+
- **API specs** - See `memory/30-domains/*/api.md`
|
|
111
|
+
|
|
112
|
+
---
|
|
113
|
+
|
|
114
|
+
## 🛠️ Common Tasks
|
|
115
|
+
|
|
116
|
+
### View Logs
|
|
117
|
+
```bash
|
|
118
|
+
# All services
|
|
119
|
+
docker-compose logs -f
|
|
120
|
+
|
|
121
|
+
# Specific service
|
|
122
|
+
docker-compose logs -f auth-service
|
|
123
|
+
|
|
124
|
+
# Last 50 lines
|
|
125
|
+
docker-compose logs --tail=50 user-service
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
### Stop Services
|
|
129
|
+
```bash
|
|
130
|
+
docker-compose down
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
### Reset Everything
|
|
134
|
+
```bash
|
|
135
|
+
docker-compose down -v # Remove volumes too
|
|
136
|
+
docker-compose up --build
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
### Access RabbitMQ Admin
|
|
140
|
+
- URL: http://localhost:15672
|
|
141
|
+
- Username: guest
|
|
142
|
+
- Password: guest
|
|
143
|
+
|
|
144
|
+
### Access PostgreSQL
|
|
145
|
+
```bash
|
|
146
|
+
# Auth database
|
|
147
|
+
docker-compose exec postgres-auth psql -U postgres -d auth_db
|
|
148
|
+
|
|
149
|
+
# User database
|
|
150
|
+
docker-compose exec postgres-user psql -U postgres -d users_db
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
### Check Redis
|
|
154
|
+
```bash
|
|
155
|
+
docker-compose exec redis redis-cli
|
|
156
|
+
|
|
157
|
+
# Check keys
|
|
158
|
+
redis-cli KEYS "*"
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
---
|
|
162
|
+
|
|
163
|
+
## 📋 Next Steps
|
|
164
|
+
|
|
165
|
+
### 1. Explore APIs
|
|
166
|
+
- See [API-EXAMPLES.md](./API-EXAMPLES.md) for all endpoints
|
|
167
|
+
- Try different operations (create, read, update, delete)
|
|
168
|
+
- Check error handling
|
|
169
|
+
|
|
170
|
+
### 2. Understand Architecture
|
|
171
|
+
- Read [ARCHITECTURE.md](./ARCHITECTURE.md)
|
|
172
|
+
- Understand service boundaries
|
|
173
|
+
- Review communication patterns
|
|
174
|
+
|
|
175
|
+
### 3. Customize for Your Domain
|
|
176
|
+
- Update service names in memory/30-domains/
|
|
177
|
+
- Add new domains as needed
|
|
178
|
+
- Extend data models
|
|
179
|
+
- Add new endpoints
|
|
180
|
+
|
|
181
|
+
### 4. Add Database Schemas
|
|
182
|
+
- Services currently use in-memory storage
|
|
183
|
+
- Add PostgreSQL migrations
|
|
184
|
+
- See `memory/80-data/` for schema documentation
|
|
185
|
+
|
|
186
|
+
### 5. Implement Message Consumers
|
|
187
|
+
- Services publish events to RabbitMQ
|
|
188
|
+
- Implement consumers for cross-service workflows
|
|
189
|
+
- See examples in `memory/50-orchestration/`
|
|
190
|
+
|
|
191
|
+
---
|
|
192
|
+
|
|
193
|
+
## 🐛 Troubleshooting
|
|
194
|
+
|
|
195
|
+
### Port Already in Use
|
|
196
|
+
```bash
|
|
197
|
+
# Find process using port 3000
|
|
198
|
+
lsof -i :3000
|
|
199
|
+
|
|
200
|
+
# Change ports in docker-compose.yml
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
### Services won't connect
|
|
204
|
+
```bash
|
|
205
|
+
# Check network
|
|
206
|
+
docker network ls
|
|
207
|
+
|
|
208
|
+
# Check DNS resolution
|
|
209
|
+
docker-compose exec api-gateway nslookup auth-service
|
|
210
|
+
|
|
211
|
+
# Check logs
|
|
212
|
+
docker-compose logs auth-service
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
### Database errors
|
|
216
|
+
```bash
|
|
217
|
+
# Verify database is running
|
|
218
|
+
docker-compose ps postgres-auth
|
|
219
|
+
|
|
220
|
+
# Check database logs
|
|
221
|
+
docker-compose logs postgres-auth
|
|
222
|
+
|
|
223
|
+
# Reset database
|
|
224
|
+
docker-compose down -v
|
|
225
|
+
docker-compose up
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
---
|
|
229
|
+
|
|
230
|
+
## 📞 Support
|
|
231
|
+
|
|
232
|
+
For detailed information:
|
|
233
|
+
- Architecture: See [ARCHITECTURE.md](./ARCHITECTURE.md)
|
|
234
|
+
- APIs: See [API-EXAMPLES.md](./API-EXAMPLES.md)
|
|
235
|
+
- Design: See [memory/20-architecture/overview.md](./memory/20-architecture/overview.md)
|
|
236
|
+
- Services: See [memory/30-domains/](./memory/30-domains/)
|
|
237
|
+
|
|
238
|
+
---
|
|
239
|
+
|
|
240
|
+
## 📄 License
|
|
241
|
+
|
|
242
|
+
MIT
|
|
243
|
+
|
|
244
|
+
---
|
|
245
|
+
|
|
246
|
+
Enjoy building! 🎉
|
|
@@ -0,0 +1,377 @@
|
|
|
1
|
+
# 📑 Microservices Starter Kit - Complete Index
|
|
2
|
+
|
|
3
|
+
## 🚀 START HERE
|
|
4
|
+
|
|
5
|
+
**New to this boilerplate?** Start with one of these:
|
|
6
|
+
1. **[GETTING-STARTED.md](./GETTING-STARTED.md)** (5 min) - Quick start guide
|
|
7
|
+
2. **[README.md](./README.md)** (15 min) - Full overview
|
|
8
|
+
3. **docker-compose up** - Run everything
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## 📚 Documentation Files (Root)
|
|
13
|
+
|
|
14
|
+
| File | Purpose | Read Time |
|
|
15
|
+
|------|---------|-----------|
|
|
16
|
+
| [GETTING-STARTED.md](./GETTING-STARTED.md) | ⚡ Quick start (30 seconds) | 5 min |
|
|
17
|
+
| [README.md](./README.md) | 📖 Project overview & guide | 15 min |
|
|
18
|
+
| [ARCHITECTURE.md](./ARCHITECTURE.md) | 🏗️ System design & topology | 20 min |
|
|
19
|
+
| [API-EXAMPLES.md](./API-EXAMPLES.md) | 📝 Curl examples for all endpoints | 10 min |
|
|
20
|
+
| [SUMMARY.md](./SUMMARY.md) | 📊 What was created | 10 min |
|
|
21
|
+
| [MANIFEST.md](./MANIFEST.md) | ✅ Deliverables checklist | 5 min |
|
|
22
|
+
| [INDEX.md](./INDEX.md) | 📑 This file | 3 min |
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## 🧠 Memory System (Knowledge Base)
|
|
27
|
+
|
|
28
|
+
### Level 00: Global Context (5 files)
|
|
29
|
+
The foundation - mission, patterns, policies
|
|
30
|
+
|
|
31
|
+
| File | Purpose |
|
|
32
|
+
|------|---------|
|
|
33
|
+
| [memory/00-global/mission.md](./memory/00-global/mission.md) | 🎯 Vision & objectives |
|
|
34
|
+
| [memory/00-global/patterns.md](./memory/00-global/patterns.md) | 🏗️ Architectural patterns |
|
|
35
|
+
| [memory/00-global/context-policy.md](./memory/00-global/context-policy.md) | 📋 Request/response standards |
|
|
36
|
+
| [memory/00-global/agent-contract.md](./memory/00-global/agent-contract.md) | 📜 Service contracts & SLAs |
|
|
37
|
+
| [memory/00-global/index.md](./memory/00-global/index.md) | 🗺️ Navigation guide |
|
|
38
|
+
|
|
39
|
+
### Level 10: Product Context (1 file)
|
|
40
|
+
Business vision and roadmap
|
|
41
|
+
|
|
42
|
+
| File | Purpose |
|
|
43
|
+
|------|---------|
|
|
44
|
+
| [memory/10-product/vision.md](./memory/10-product/vision.md) | 👁️ Vision & roadmap |
|
|
45
|
+
|
|
46
|
+
### Level 20: Architecture (1 file)
|
|
47
|
+
System design details
|
|
48
|
+
|
|
49
|
+
| File | Purpose |
|
|
50
|
+
|------|---------|
|
|
51
|
+
| [memory/20-architecture/overview.md](./memory/20-architecture/overview.md) | 🏛️ Complete system architecture |
|
|
52
|
+
|
|
53
|
+
### Level 30: Domains (6 files)
|
|
54
|
+
Three bounded contexts - Auth, User, Notification
|
|
55
|
+
|
|
56
|
+
**Auth Service:**
|
|
57
|
+
| File | Purpose |
|
|
58
|
+
|------|---------|
|
|
59
|
+
| [memory/30-domains/auth-service/context.md](./memory/30-domains/auth-service/context.md) | 🔐 Bounded context |
|
|
60
|
+
| [memory/30-domains/auth-service/api.md](./memory/30-domains/auth-service/api.md) | 📡 API specification |
|
|
61
|
+
|
|
62
|
+
**User Service:**
|
|
63
|
+
| File | Purpose |
|
|
64
|
+
|------|---------|
|
|
65
|
+
| [memory/30-domains/user-service/context.md](./memory/30-domains/user-service/context.md) | 👤 Bounded context |
|
|
66
|
+
| [memory/30-domains/user-service/api.md](./memory/30-domains/user-service/api.md) | 📡 API specification |
|
|
67
|
+
|
|
68
|
+
**Notification Service:**
|
|
69
|
+
| File | Purpose |
|
|
70
|
+
|------|---------|
|
|
71
|
+
| [memory/30-domains/notification-service/context.md](./memory/30-domains/notification-service/context.md) | 📧 Bounded context |
|
|
72
|
+
| [memory/30-domains/notification-service/api.md](./memory/30-domains/notification-service/api.md) | 📡 API specification |
|
|
73
|
+
|
|
74
|
+
### Level 40-90: Other Levels
|
|
75
|
+
Ready for your content
|
|
76
|
+
|
|
77
|
+
| Level | Purpose | Status |
|
|
78
|
+
|-------|---------|--------|
|
|
79
|
+
| 40-delivery | Roadmap & sprints | 📝 Ready for content |
|
|
80
|
+
| 50-orchestration | Service topology & routing | ✅ topology.md created |
|
|
81
|
+
| 60-runs | Execution logs | 📝 Ready for content |
|
|
82
|
+
| 70-summaries | Quick references | 📝 Ready for content |
|
|
83
|
+
| 80-data | Database schemas | 📝 Ready for content |
|
|
84
|
+
| 90-decisions | Architecture decisions (ADRs) | 📝 Ready for content |
|
|
85
|
+
|
|
86
|
+
---
|
|
87
|
+
|
|
88
|
+
## 🔗 Orchestration
|
|
89
|
+
|
|
90
|
+
### Service Topology
|
|
91
|
+
- [memory/50-orchestration/topology.md](./memory/50-orchestration/topology.md) - Service discovery, ports, DNS
|
|
92
|
+
|
|
93
|
+
---
|
|
94
|
+
|
|
95
|
+
## 💻 Backend Code
|
|
96
|
+
|
|
97
|
+
### API Gateway (Entry Point, Port 3000)
|
|
98
|
+
```
|
|
99
|
+
backend/api-gateway/
|
|
100
|
+
├── package.json
|
|
101
|
+
├── tsconfig.json
|
|
102
|
+
├── Dockerfile
|
|
103
|
+
└── src/
|
|
104
|
+
├── main.ts
|
|
105
|
+
├── app.module.ts
|
|
106
|
+
├── gateway.controller.ts
|
|
107
|
+
└── gateway.service.ts
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### Auth Service (OAuth2, JWT, Port 3001)
|
|
111
|
+
```
|
|
112
|
+
backend/services/auth-service/
|
|
113
|
+
├── package.json
|
|
114
|
+
├── tsconfig.json
|
|
115
|
+
├── Dockerfile
|
|
116
|
+
└── src/
|
|
117
|
+
├── main.ts
|
|
118
|
+
├── app.module.ts
|
|
119
|
+
└── modules/auth/
|
|
120
|
+
├── auth.module.ts
|
|
121
|
+
├── auth.service.ts
|
|
122
|
+
├── auth.controller.ts
|
|
123
|
+
├── jwt.strategy.ts
|
|
124
|
+
└── local.strategy.ts
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
### User Service (Profiles, Port 3002)
|
|
128
|
+
```
|
|
129
|
+
backend/services/user-service/
|
|
130
|
+
├── package.json
|
|
131
|
+
├── tsconfig.json
|
|
132
|
+
├── Dockerfile
|
|
133
|
+
└── src/
|
|
134
|
+
├── main.ts
|
|
135
|
+
├── app.module.ts
|
|
136
|
+
└── modules/user/
|
|
137
|
+
├── user.module.ts
|
|
138
|
+
├── user.service.ts
|
|
139
|
+
└── user.controller.ts
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
### Notification Service (Emails, Push, Port 3003)
|
|
143
|
+
```
|
|
144
|
+
backend/services/notification-service/
|
|
145
|
+
├── package.json
|
|
146
|
+
├── tsconfig.json
|
|
147
|
+
├── Dockerfile
|
|
148
|
+
└── src/
|
|
149
|
+
├── main.ts
|
|
150
|
+
├── app.module.ts
|
|
151
|
+
└── modules/notification/
|
|
152
|
+
├── notification.module.ts
|
|
153
|
+
├── notification.service.ts
|
|
154
|
+
└── notification.controller.ts
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
### Shared Package (Types & Utils)
|
|
158
|
+
```
|
|
159
|
+
backend/shared/
|
|
160
|
+
├── package.json
|
|
161
|
+
├── tsconfig.json
|
|
162
|
+
└── src/
|
|
163
|
+
├── index.ts
|
|
164
|
+
├── interfaces/
|
|
165
|
+
├── constants/
|
|
166
|
+
├── utils/
|
|
167
|
+
└── decorators/
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
---
|
|
171
|
+
|
|
172
|
+
## 🐳 Infrastructure
|
|
173
|
+
|
|
174
|
+
### Docker Compose
|
|
175
|
+
- [docker-compose.yml](./docker-compose.yml) - Complete orchestration
|
|
176
|
+
|
|
177
|
+
**Services Running:**
|
|
178
|
+
- api-gateway:3000
|
|
179
|
+
- auth-service:3001 + PostgreSQL
|
|
180
|
+
- user-service:3002 + PostgreSQL
|
|
181
|
+
- notification-service:3003
|
|
182
|
+
- RabbitMQ:5672 (Admin:15672)
|
|
183
|
+
- Redis:6379
|
|
184
|
+
|
|
185
|
+
### Configuration
|
|
186
|
+
- [.env.example](./.env.example) - Environment template
|
|
187
|
+
|
|
188
|
+
---
|
|
189
|
+
|
|
190
|
+
## 📡 API Endpoints
|
|
191
|
+
|
|
192
|
+
### Quick Reference
|
|
193
|
+
**[API-EXAMPLES.md](./API-EXAMPLES.md)** has curl examples for all endpoints
|
|
194
|
+
|
|
195
|
+
**Summary:**
|
|
196
|
+
- Auth Service: 5 endpoints + health
|
|
197
|
+
- User Service: 8 endpoints + health
|
|
198
|
+
- Notification Service: 5 endpoints + health
|
|
199
|
+
- **Total: 20 endpoints**
|
|
200
|
+
|
|
201
|
+
---
|
|
202
|
+
|
|
203
|
+
## 🔍 How to Navigate
|
|
204
|
+
|
|
205
|
+
### By Role
|
|
206
|
+
|
|
207
|
+
**Architect/Tech Lead:**
|
|
208
|
+
1. Read [ARCHITECTURE.md](./ARCHITECTURE.md)
|
|
209
|
+
2. Review [memory/00-global/patterns.md](./memory/00-global/patterns.md)
|
|
210
|
+
3. Check [memory/20-architecture/overview.md](./memory/20-architecture/overview.md)
|
|
211
|
+
4. Study [memory/30-domains/](./memory/30-domains/) for service boundaries
|
|
212
|
+
|
|
213
|
+
**Backend Developer:**
|
|
214
|
+
1. Start [GETTING-STARTED.md](./GETTING-STARTED.md)
|
|
215
|
+
2. Run `docker-compose up`
|
|
216
|
+
3. Test with [API-EXAMPLES.md](./API-EXAMPLES.md)
|
|
217
|
+
4. Explore service code in `backend/services/`
|
|
218
|
+
5. Check [memory/30-domains/*/api.md](./memory/30-domains/) for specs
|
|
219
|
+
|
|
220
|
+
**DevOps/Infrastructure:**
|
|
221
|
+
1. Review [docker-compose.yml](./docker-compose.yml)
|
|
222
|
+
2. Check [memory/50-orchestration/topology.md](./memory/50-orchestration/topology.md)
|
|
223
|
+
3. See `.env.example` for configuration
|
|
224
|
+
4. Review Dockerfiles in `backend/*/`
|
|
225
|
+
|
|
226
|
+
**Product Manager:**
|
|
227
|
+
1. Read [memory/10-product/vision.md](./memory/10-product/vision.md)
|
|
228
|
+
2. Check [memory/30-domains/](./memory/30-domains/) for feature specs
|
|
229
|
+
3. Review [ARCHITECTURE.md](./ARCHITECTURE.md) for capabilities
|
|
230
|
+
|
|
231
|
+
### By Task
|
|
232
|
+
|
|
233
|
+
**Setting up locally:**
|
|
234
|
+
1. [GETTING-STARTED.md](./GETTING-STARTED.md)
|
|
235
|
+
2. Run `docker-compose up`
|
|
236
|
+
|
|
237
|
+
**Learning the API:**
|
|
238
|
+
1. [API-EXAMPLES.md](./API-EXAMPLES.md)
|
|
239
|
+
2. Read [memory/30-domains/*/api.md](./memory/30-domains/)
|
|
240
|
+
|
|
241
|
+
**Understanding architecture:**
|
|
242
|
+
1. [ARCHITECTURE.md](./ARCHITECTURE.md)
|
|
243
|
+
2. [memory/20-architecture/overview.md](./memory/20-architecture/overview.md)
|
|
244
|
+
3. [memory/50-orchestration/topology.md](./memory/50-orchestration/topology.md)
|
|
245
|
+
|
|
246
|
+
**Extending services:**
|
|
247
|
+
1. [memory/00-global/patterns.md](./memory/00-global/patterns.md)
|
|
248
|
+
2. Look at existing service in `backend/services/`
|
|
249
|
+
3. Check [memory/30-domains/*/context.md](./memory/30-domains/) for DDD patterns
|
|
250
|
+
|
|
251
|
+
**Deploying to production:**
|
|
252
|
+
1. [memory/50-orchestration/topology.md](./memory/50-orchestration/topology.md)
|
|
253
|
+
2. Modify docker-compose.yml for your environment
|
|
254
|
+
3. Deploy to Kubernetes (structure is K8s-ready)
|
|
255
|
+
|
|
256
|
+
---
|
|
257
|
+
|
|
258
|
+
## 🎯 Service Descriptions
|
|
259
|
+
|
|
260
|
+
### Auth Service 🔐
|
|
261
|
+
- **Purpose:** Authentication & authorization
|
|
262
|
+
- **Endpoints:** 5 (register, login, refresh, verify, logout)
|
|
263
|
+
- **Database:** PostgreSQL (auth_db)
|
|
264
|
+
- **Tech:** Passport.js, JWT, bcrypt
|
|
265
|
+
- **File:** [memory/30-domains/auth-service/](./memory/30-domains/auth-service/)
|
|
266
|
+
|
|
267
|
+
### User Service 👤
|
|
268
|
+
- **Purpose:** User profiles & settings
|
|
269
|
+
- **Endpoints:** 8 (CRUD + settings + verify email + list)
|
|
270
|
+
- **Database:** PostgreSQL (users_db)
|
|
271
|
+
- **Tech:** NestJS, TypeScript
|
|
272
|
+
- **File:** [memory/30-domains/user-service/](./memory/30-domains/user-service/)
|
|
273
|
+
|
|
274
|
+
### Notification Service 📧
|
|
275
|
+
- **Purpose:** Multi-channel notifications
|
|
276
|
+
- **Endpoints:** 5 (email, push, status, list, templates)
|
|
277
|
+
- **Storage:** Redis only (stateless)
|
|
278
|
+
- **Tech:** RabbitMQ consumer, templates
|
|
279
|
+
- **File:** [memory/30-domains/notification-service/](./memory/30-domains/notification-service/)
|
|
280
|
+
|
|
281
|
+
### API Gateway 🚪
|
|
282
|
+
- **Purpose:** Entry point & routing
|
|
283
|
+
- **Endpoints:** All above services
|
|
284
|
+
- **Features:** CORS, error handling, service discovery
|
|
285
|
+
- **Tech:** NestJS, Axios
|
|
286
|
+
- **Code:** [backend/api-gateway/](./backend/api-gateway/)
|
|
287
|
+
|
|
288
|
+
---
|
|
289
|
+
|
|
290
|
+
## 📊 Statistics
|
|
291
|
+
|
|
292
|
+
| Metric | Count |
|
|
293
|
+
|--------|-------|
|
|
294
|
+
| Root documentation files | 8 |
|
|
295
|
+
| Memory markdown files | 14+ |
|
|
296
|
+
| Backend services | 4 |
|
|
297
|
+
| API endpoints | 20 |
|
|
298
|
+
| TypeScript files | 15+ |
|
|
299
|
+
| Configuration files | 20+ |
|
|
300
|
+
| Docker files | 5 |
|
|
301
|
+
| Total files | 62+ |
|
|
302
|
+
| Lines of documentation | 2,675+ |
|
|
303
|
+
| Lines of code (TS) | 2,500+ |
|
|
304
|
+
|
|
305
|
+
---
|
|
306
|
+
|
|
307
|
+
## ✅ Quick Checklist
|
|
308
|
+
|
|
309
|
+
Getting started:
|
|
310
|
+
- [ ] Read [GETTING-STARTED.md](./GETTING-STARTED.md)
|
|
311
|
+
- [ ] Run `docker-compose up`
|
|
312
|
+
- [ ] Test login with provided credentials
|
|
313
|
+
- [ ] Try API examples from [API-EXAMPLES.md](./API-EXAMPLES.md)
|
|
314
|
+
- [ ] Read [README.md](./README.md) for overview
|
|
315
|
+
- [ ] Explore [ARCHITECTURE.md](./ARCHITECTURE.md)
|
|
316
|
+
- [ ] Check service code in `backend/services/`
|
|
317
|
+
- [ ] Review memory system for deeper knowledge
|
|
318
|
+
|
|
319
|
+
---
|
|
320
|
+
|
|
321
|
+
## 🎓 Learning Path
|
|
322
|
+
|
|
323
|
+
**30 Minutes:**
|
|
324
|
+
1. GETTING-STARTED.md (5 min)
|
|
325
|
+
2. docker-compose up (5 min)
|
|
326
|
+
3. Test API examples (10 min)
|
|
327
|
+
4. Explore endpoints (10 min)
|
|
328
|
+
|
|
329
|
+
**2 Hours:**
|
|
330
|
+
1. README.md (15 min)
|
|
331
|
+
2. ARCHITECTURE.md (20 min)
|
|
332
|
+
3. API-EXAMPLES.md (10 min)
|
|
333
|
+
4. Explore code (30 min)
|
|
334
|
+
5. memory/30-domains/ (45 min)
|
|
335
|
+
|
|
336
|
+
**4 Hours:**
|
|
337
|
+
1. All above + 2 more hours
|
|
338
|
+
2. memory/00-global/ (30 min)
|
|
339
|
+
3. memory/20-architecture/overview.md (20 min)
|
|
340
|
+
4. memory/50-orchestration/topology.md (20 min)
|
|
341
|
+
5. Review all backend code (30 min)
|
|
342
|
+
|
|
343
|
+
---
|
|
344
|
+
|
|
345
|
+
## 🔗 External Links
|
|
346
|
+
|
|
347
|
+
**Technologies:**
|
|
348
|
+
- [NestJS Documentation](https://docs.nestjs.com/)
|
|
349
|
+
- [Docker Documentation](https://docs.docker.com/)
|
|
350
|
+
- [RabbitMQ Documentation](https://www.rabbitmq.com/documentation.html)
|
|
351
|
+
- [PostgreSQL Documentation](https://www.postgresql.org/docs/)
|
|
352
|
+
- [Redis Documentation](https://redis.io/documentation)
|
|
353
|
+
|
|
354
|
+
---
|
|
355
|
+
|
|
356
|
+
## 📞 Questions?
|
|
357
|
+
|
|
358
|
+
Check these files in order:
|
|
359
|
+
1. [README.md](./README.md) - General questions
|
|
360
|
+
2. [ARCHITECTURE.md](./ARCHITECTURE.md) - Design questions
|
|
361
|
+
3. [API-EXAMPLES.md](./API-EXAMPLES.md) - API questions
|
|
362
|
+
4. [memory/](./memory/) - Deep knowledge
|
|
363
|
+
5. Source code comments
|
|
364
|
+
|
|
365
|
+
---
|
|
366
|
+
|
|
367
|
+
## 🎉 You're Ready!
|
|
368
|
+
|
|
369
|
+
Everything is here. Pick a starting point above and begin exploring!
|
|
370
|
+
|
|
371
|
+
**Recommended first step:** Read [GETTING-STARTED.md](./GETTING-STARTED.md) then run `docker-compose up`
|
|
372
|
+
|
|
373
|
+
---
|
|
374
|
+
|
|
375
|
+
**Last Updated:** 2024
|
|
376
|
+
**Status:** ✅ Complete & Ready to Use
|
|
377
|
+
**Version:** 1.0
|