proagents 1.6.17 → 1.6.18

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.
Files changed (168) hide show
  1. package/.claude/settings.local.json +169 -0
  2. package/COMMANDS.md +595 -0
  3. package/README.md +13 -23
  4. package/package.json +2 -7
  5. package/.proagents/ai-models/README.md +0 -141
  6. package/.proagents/ai-models/cost-management.md +0 -362
  7. package/.proagents/ai-models/fallbacks.md +0 -342
  8. package/.proagents/ai-models/model-config.md +0 -318
  9. package/.proagents/ai-models/task-routing.md +0 -503
  10. package/.proagents/ai-training/README.md +0 -155
  11. package/.proagents/ai-training/continuous-learning.md +0 -413
  12. package/.proagents/ai-training/domain-knowledge.md +0 -378
  13. package/.proagents/ai-training/pattern-learning.md +0 -455
  14. package/.proagents/ai-training/training-data.md +0 -337
  15. package/.proagents/ai-training/user-preferences.md +0 -346
  16. package/.proagents/approval-workflows/README.md +0 -146
  17. package/.proagents/approval-workflows/approval-config.md +0 -332
  18. package/.proagents/approval-workflows/approval-stages.md +0 -503
  19. package/.proagents/approval-workflows/emergency-bypass.md +0 -351
  20. package/.proagents/approval-workflows/examples.md +0 -859
  21. package/.proagents/approval-workflows/notifications.md +0 -320
  22. package/.proagents/compliance/README.md +0 -206
  23. package/.proagents/compliance/access-control.md +0 -310
  24. package/.proagents/compliance/audit-logging.md +0 -444
  25. package/.proagents/compliance/compliance-frameworks.md +0 -429
  26. package/.proagents/compliance/reports.md +0 -491
  27. package/.proagents/compliance/retention-policies.md +0 -454
  28. package/.proagents/config-versioning/README.md +0 -120
  29. package/.proagents/config-versioning/changelog.md +0 -300
  30. package/.proagents/config-versioning/rollback.md +0 -283
  31. package/.proagents/config-versioning/versioning.md +0 -330
  32. package/.proagents/contract-testing/README.md +0 -223
  33. package/.proagents/contract-testing/contract-testing.md +0 -614
  34. package/.proagents/contract-testing/pact-integration.md +0 -507
  35. package/.proagents/contract-testing/schema-validation.md +0 -565
  36. package/.proagents/dependency-management/README.md +0 -140
  37. package/.proagents/dependency-management/automation.md +0 -363
  38. package/.proagents/dependency-management/compatibility.md +0 -319
  39. package/.proagents/dependency-management/security-scanning.md +0 -413
  40. package/.proagents/dependency-management/update-policies.md +0 -374
  41. package/.proagents/disaster-recovery/README.md +0 -247
  42. package/.proagents/disaster-recovery/automation.md +0 -366
  43. package/.proagents/disaster-recovery/backup-recovery.md +0 -571
  44. package/.proagents/disaster-recovery/incident-response.md +0 -565
  45. package/.proagents/disaster-recovery/rollback-procedures.md +0 -499
  46. package/.proagents/disaster-recovery/runbooks.md +0 -603
  47. package/.proagents/disaster-recovery/scenarios.md +0 -892
  48. package/.proagents/disaster-recovery/testing.md +0 -438
  49. package/.proagents/environments/README.md +0 -244
  50. package/.proagents/environments/configuration.md +0 -437
  51. package/.proagents/environments/promotion.md +0 -434
  52. package/.proagents/environments/setup.md +0 -420
  53. package/.proagents/examples/README.md +0 -55
  54. package/.proagents/examples/backend-nodejs/README.md +0 -188
  55. package/.proagents/examples/backend-nodejs/complete-conversation.md +0 -601
  56. package/.proagents/examples/backend-nodejs/proagents.config.yaml +0 -415
  57. package/.proagents/examples/backend-nodejs/workflow-example.md +0 -909
  58. package/.proagents/examples/fullstack-nextjs/README.md +0 -155
  59. package/.proagents/examples/fullstack-nextjs/complete-conversation.md +0 -604
  60. package/.proagents/examples/fullstack-nextjs/proagents.config.yaml +0 -287
  61. package/.proagents/examples/fullstack-nextjs/workflow-example.md +0 -553
  62. package/.proagents/examples/mobile-react-native/README.md +0 -171
  63. package/.proagents/examples/mobile-react-native/complete-conversation.md +0 -825
  64. package/.proagents/examples/mobile-react-native/proagents.config.yaml +0 -330
  65. package/.proagents/examples/mobile-react-native/workflow-example.md +0 -723
  66. package/.proagents/examples/web-frontend-react/README.md +0 -125
  67. package/.proagents/examples/web-frontend-react/complete-conversation.md +0 -556
  68. package/.proagents/examples/web-frontend-react/proagents.config.yaml +0 -183
  69. package/.proagents/examples/web-frontend-react/workflow-example.md +0 -603
  70. package/.proagents/existing-projects/README.md +0 -65
  71. package/.proagents/existing-projects/challenges.md +0 -861
  72. package/.proagents/existing-projects/coexistence-mode.md +0 -483
  73. package/.proagents/existing-projects/compatibility-assessment.md +0 -541
  74. package/.proagents/existing-projects/gradual-adoption.md +0 -515
  75. package/.proagents/existing-projects/migration-strategies.md +0 -788
  76. package/.proagents/existing-projects/pattern-reconciliation.md +0 -489
  77. package/.proagents/existing-projects/team-onboarding.md +0 -617
  78. package/.proagents/existing-projects/technical-debt-handling.md +0 -644
  79. package/.proagents/feature-flags/README.md +0 -263
  80. package/.proagents/feature-flags/ab-testing.md +0 -413
  81. package/.proagents/feature-flags/configuration.md +0 -420
  82. package/.proagents/feature-flags/kill-switches.md +0 -444
  83. package/.proagents/feature-flags/rollout-strategies.md +0 -392
  84. package/.proagents/history.log +0 -12
  85. package/.proagents/i18n/README.md +0 -133
  86. package/.proagents/i18n/extraction.md +0 -433
  87. package/.proagents/i18n/tms-integration.md +0 -332
  88. package/.proagents/i18n/translation-workflow.md +0 -413
  89. package/.proagents/i18n/validation.md +0 -355
  90. package/.proagents/logging/README.md +0 -276
  91. package/.proagents/logging/aggregation.md +0 -475
  92. package/.proagents/logging/log-levels.md +0 -376
  93. package/.proagents/logging/sensitive-data.md +0 -423
  94. package/.proagents/logging/structured-logging.md +0 -406
  95. package/.proagents/metrics/README.md +0 -69
  96. package/.proagents/metrics/code-quality-kpis.md +0 -461
  97. package/.proagents/metrics/deployment-metrics.md +0 -517
  98. package/.proagents/metrics/developer-productivity.md +0 -368
  99. package/.proagents/metrics/learning-effectiveness.md +0 -478
  100. package/.proagents/migrations/README.md +0 -77
  101. package/.proagents/migrations/from-claude-projects.md +0 -313
  102. package/.proagents/migrations/from-cursor-rules.md +0 -345
  103. package/.proagents/migrations/from-custom-workflows.md +0 -410
  104. package/.proagents/monitoring/README.md +0 -308
  105. package/.proagents/monitoring/alerting.md +0 -449
  106. package/.proagents/monitoring/dashboards.md +0 -454
  107. package/.proagents/monitoring/health-checks.md +0 -436
  108. package/.proagents/monitoring/metrics.md +0 -434
  109. package/.proagents/multi-project/README.md +0 -170
  110. package/.proagents/multi-project/coordinated-deploy.md +0 -510
  111. package/.proagents/multi-project/cross-project-deps.md +0 -395
  112. package/.proagents/multi-project/unified-changelog.md +0 -477
  113. package/.proagents/multi-project/walkthroughs/monorepo-setup.md +0 -787
  114. package/.proagents/multi-project/workspace-config.md +0 -408
  115. package/.proagents/notifications/README.md +0 -151
  116. package/.proagents/notifications/channels.md +0 -457
  117. package/.proagents/notifications/preferences.md +0 -415
  118. package/.proagents/notifications/routing.md +0 -449
  119. package/.proagents/notifications/scheduling.md +0 -425
  120. package/.proagents/notifications/templates.md +0 -446
  121. package/.proagents/offline-mode/README.md +0 -145
  122. package/.proagents/offline-mode/caching.md +0 -344
  123. package/.proagents/offline-mode/offline-operations.md +0 -312
  124. package/.proagents/offline-mode/queue-specifications.md +0 -679
  125. package/.proagents/offline-mode/sync.md +0 -475
  126. package/.proagents/parallel-features/README.md +0 -85
  127. package/.proagents/parallel-features/conflict-detection.md +0 -226
  128. package/.proagents/parallel-features/dependency-management.md +0 -392
  129. package/.proagents/parallel-features/merge-coordination.md +0 -506
  130. package/.proagents/parallel-features/tracking-system.md +0 -416
  131. package/.proagents/performance/README.md +0 -59
  132. package/.proagents/performance/bundle-analysis.md +0 -375
  133. package/.proagents/performance/load-testing.md +0 -563
  134. package/.proagents/performance/runtime-metrics.md +0 -489
  135. package/.proagents/performance/web-vitals.md +0 -425
  136. package/.proagents/plugins/README.md +0 -139
  137. package/.proagents/plugins/creating-plugins.md +0 -504
  138. package/.proagents/plugins/plugin-api.md +0 -467
  139. package/.proagents/plugins/plugin-registry.md +0 -276
  140. package/.proagents/reporting/README.md +0 -158
  141. package/.proagents/reporting/dashboards.md +0 -366
  142. package/.proagents/reporting/exports.md +0 -524
  143. package/.proagents/reporting/quality-metrics.md +0 -385
  144. package/.proagents/reporting/templates/README.md +0 -56
  145. package/.proagents/reporting/templates/dashboard-config.json +0 -187
  146. package/.proagents/reporting/templates/metrics-queries.md +0 -427
  147. package/.proagents/reporting/templates/react-dashboard.tsx +0 -544
  148. package/.proagents/reporting/templates/widgets.md +0 -451
  149. package/.proagents/reporting/velocity-metrics.md +0 -340
  150. package/.proagents/reverse-engineering/README.md +0 -151
  151. package/.proagents/reverse-engineering/architecture-extraction.md +0 -325
  152. package/.proagents/reverse-engineering/code-analysis.md +0 -377
  153. package/.proagents/reverse-engineering/dependency-mapping.md +0 -567
  154. package/.proagents/reverse-engineering/diagram-generation.md +0 -586
  155. package/.proagents/reverse-engineering/documentation-generation.md +0 -468
  156. package/.proagents/reverse-engineering/pattern-detection.md +0 -569
  157. package/.proagents/reverse-engineering/quality-assessment.md +0 -733
  158. package/.proagents/secrets/README.md +0 -278
  159. package/.proagents/secrets/access-control.md +0 -443
  160. package/.proagents/secrets/rotation.md +0 -403
  161. package/.proagents/secrets/scanning.md +0 -487
  162. package/.proagents/secrets/storage.md +0 -394
  163. package/.proagents/webhooks/README.md +0 -126
  164. package/.proagents/webhooks/endpoints.md +0 -298
  165. package/.proagents/webhooks/events.md +0 -316
  166. package/.proagents/webhooks/payloads.md +0 -325
  167. package/.proagents/webhooks/reliability.md +0 -363
  168. package/.proagents/webhooks/security.md +0 -380
@@ -1,420 +0,0 @@
1
- # Environment Setup
2
-
3
- Guide to setting up and configuring different environments.
4
-
5
- ---
6
-
7
- ## Environment Types
8
-
9
- | Environment | Purpose | Data | Access |
10
- |-------------|---------|------|--------|
11
- | **Local** | Developer workstation | Mock/seed data | Individual |
12
- | **Development** | Shared development | Synthetic data | Team |
13
- | **Staging** | Pre-production testing | Production-like | Team + QA |
14
- | **Production** | Live system | Real data | Restricted |
15
-
16
- ---
17
-
18
- ## Local Environment Setup
19
-
20
- ### Prerequisites
21
-
22
- ```bash
23
- # Required tools
24
- node --version # >= 18.x
25
- npm --version # >= 9.x
26
- docker --version # >= 24.x
27
- git --version # >= 2.x
28
- ```
29
-
30
- ### Quick Start
31
-
32
- ```bash
33
- # Clone repository
34
- git clone ${REPO_URL}
35
- cd project
36
-
37
- # Install dependencies
38
- npm install
39
-
40
- # Copy environment file
41
- cp .env.example .env.local
42
-
43
- # Start local services
44
- docker-compose up -d
45
-
46
- # Run database migrations
47
- npm run db:migrate
48
-
49
- # Seed development data
50
- npm run db:seed
51
-
52
- # Start development server
53
- npm run dev
54
- ```
55
-
56
- ### Local Environment File
57
-
58
- ```bash
59
- # .env.local
60
- NODE_ENV=development
61
-
62
- # Application
63
- APP_URL=http://localhost:3000
64
- API_URL=http://localhost:3001
65
-
66
- # Database
67
- DATABASE_URL=postgresql://user:pass@localhost:5432/app_dev
68
-
69
- # Redis
70
- REDIS_URL=redis://localhost:6379
71
-
72
- # Auth (development keys)
73
- JWT_SECRET=dev-secret-key-change-in-production
74
- SESSION_SECRET=dev-session-secret
75
-
76
- # External Services (use mocks)
77
- USE_MOCK_SERVICES=true
78
- MOCK_PAYMENT_GATEWAY=true
79
-
80
- # Debug
81
- DEBUG=app:*
82
- LOG_LEVEL=debug
83
- ```
84
-
85
- ### Docker Compose for Local
86
-
87
- ```yaml
88
- # docker-compose.yml
89
- version: '3.8'
90
-
91
- services:
92
- postgres:
93
- image: postgres:15
94
- environment:
95
- POSTGRES_DB: app_dev
96
- POSTGRES_USER: user
97
- POSTGRES_PASSWORD: pass
98
- ports:
99
- - "5432:5432"
100
- volumes:
101
- - postgres_data:/var/lib/postgresql/data
102
-
103
- redis:
104
- image: redis:7
105
- ports:
106
- - "6379:6379"
107
-
108
- mailhog:
109
- image: mailhog/mailhog
110
- ports:
111
- - "1025:1025" # SMTP
112
- - "8025:8025" # Web UI
113
-
114
- volumes:
115
- postgres_data:
116
- ```
117
-
118
- ---
119
-
120
- ## Development Environment Setup
121
-
122
- ### Cloud Development Environment
123
-
124
- ```yaml
125
- # proagents.config.yaml
126
- environments:
127
- development:
128
- type: "cloud"
129
- provider: "aws" # or gcp, azure
130
-
131
- infrastructure:
132
- compute:
133
- type: "ecs-fargate"
134
- cpu: 256
135
- memory: 512
136
-
137
- database:
138
- type: "rds-postgres"
139
- instance: "db.t3.micro"
140
- storage: 20
141
-
142
- cache:
143
- type: "elasticache-redis"
144
- node_type: "cache.t3.micro"
145
-
146
- networking:
147
- vpc: "dev-vpc"
148
- subnets: ["dev-subnet-1", "dev-subnet-2"]
149
- ```
150
-
151
- ### Development Environment Variables
152
-
153
- ```bash
154
- # .env.development
155
- NODE_ENV=development
156
-
157
- # Application
158
- APP_URL=https://dev.app.example.com
159
- API_URL=https://dev-api.app.example.com
160
-
161
- # Database (from secrets manager)
162
- DATABASE_URL=${aws:secretsmanager:dev/database/url}
163
-
164
- # External Services
165
- STRIPE_API_KEY=${aws:secretsmanager:dev/stripe/key}
166
- SENDGRID_API_KEY=${aws:secretsmanager:dev/sendgrid/key}
167
-
168
- # Feature Flags
169
- FEATURE_FLAGS_ENV=development
170
- ENABLE_DEBUG_ENDPOINTS=true
171
- ```
172
-
173
- ### Development Access
174
-
175
- ```yaml
176
- environments:
177
- development:
178
- access:
179
- allowed_roles: ["developer", "reviewer", "admin"]
180
- vpn_required: false
181
- ip_whitelist: ["office-ip-range"]
182
-
183
- monitoring:
184
- log_level: "debug"
185
- metrics_enabled: true
186
- error_tracking: true
187
- ```
188
-
189
- ---
190
-
191
- ## Staging Environment Setup
192
-
193
- ### Staging Configuration
194
-
195
- ```yaml
196
- environments:
197
- staging:
198
- type: "cloud"
199
- provider: "aws"
200
-
201
- infrastructure:
202
- compute:
203
- type: "ecs-fargate"
204
- cpu: 512
205
- memory: 1024
206
- replicas: 2
207
-
208
- database:
209
- type: "rds-postgres"
210
- instance: "db.t3.small"
211
- storage: 50
212
- multi_az: false
213
-
214
- cache:
215
- type: "elasticache-redis"
216
- node_type: "cache.t3.small"
217
-
218
- # Mirror production settings
219
- settings:
220
- ssl_enabled: true
221
- rate_limiting: true
222
- cdn_enabled: true
223
- ```
224
-
225
- ### Staging Data Strategy
226
-
227
- ```yaml
228
- environments:
229
- staging:
230
- data:
231
- strategy: "production_subset"
232
-
233
- # Anonymize production data
234
- anonymization:
235
- enabled: true
236
- rules:
237
- - table: "users"
238
- fields:
239
- email: "faker.email"
240
- name: "faker.name"
241
- phone: "mask"
242
-
243
- - table: "payments"
244
- fields:
245
- card_number: "mask"
246
- cvv: "remove"
247
-
248
- # Refresh schedule
249
- refresh:
250
- schedule: "weekly"
251
- day: "sunday"
252
- time: "02:00"
253
- ```
254
-
255
- ### Staging Environment Variables
256
-
257
- ```bash
258
- # .env.staging
259
- NODE_ENV=staging
260
-
261
- # Application
262
- APP_URL=https://staging.app.example.com
263
- API_URL=https://staging-api.app.example.com
264
-
265
- # Database
266
- DATABASE_URL=${aws:secretsmanager:staging/database/url}
267
-
268
- # External Services (sandbox/test accounts)
269
- STRIPE_API_KEY=${aws:secretsmanager:staging/stripe/key}
270
- STRIPE_WEBHOOK_SECRET=${aws:secretsmanager:staging/stripe/webhook}
271
-
272
- # Feature Flags
273
- FEATURE_FLAGS_ENV=staging
274
- ENABLE_DEBUG_ENDPOINTS=false
275
-
276
- # Monitoring
277
- SENTRY_DSN=${aws:secretsmanager:staging/sentry/dsn}
278
- DATADOG_API_KEY=${aws:secretsmanager:staging/datadog/key}
279
- ```
280
-
281
- ---
282
-
283
- ## Production Environment Setup
284
-
285
- ### Production Infrastructure
286
-
287
- ```yaml
288
- environments:
289
- production:
290
- type: "cloud"
291
- provider: "aws"
292
- region: "us-east-1"
293
-
294
- infrastructure:
295
- compute:
296
- type: "ecs-fargate"
297
- cpu: 1024
298
- memory: 2048
299
- replicas:
300
- min: 3
301
- max: 10
302
- autoscaling:
303
- cpu_threshold: 70
304
- memory_threshold: 80
305
-
306
- database:
307
- type: "rds-postgres"
308
- instance: "db.r5.large"
309
- storage: 500
310
- multi_az: true
311
- read_replicas: 2
312
- backup_retention: 30
313
-
314
- cache:
315
- type: "elasticache-redis"
316
- node_type: "cache.r5.large"
317
- cluster_mode: true
318
- replicas: 2
319
-
320
- # High availability
321
- ha:
322
- multi_region: true
323
- dr_region: "us-west-2"
324
- failover_mode: "automatic"
325
-
326
- # Security
327
- security:
328
- waf_enabled: true
329
- ddos_protection: true
330
- encryption_at_rest: true
331
- encryption_in_transit: true
332
- ```
333
-
334
- ### Production Access Controls
335
-
336
- ```yaml
337
- environments:
338
- production:
339
- access:
340
- allowed_roles: ["deployer", "admin"]
341
- vpn_required: true
342
- mfa_required: true
343
- ip_whitelist: ["vpn-exit-ips"]
344
-
345
- # Audit all access
346
- audit:
347
- enabled: true
348
- log_all_commands: true
349
- retention: "2 years"
350
-
351
- # Deployment controls
352
- deployment:
353
- require_approval: true
354
- approvers: ["tech-lead", "sre"]
355
- deployment_window:
356
- days: ["tuesday", "wednesday", "thursday"]
357
- hours: ["10:00", "16:00"]
358
- timezone: "America/New_York"
359
- ```
360
-
361
- ---
362
-
363
- ## Environment Setup Commands
364
-
365
- ```bash
366
- # Setup new environment
367
- proagents env setup development
368
-
369
- # Verify environment configuration
370
- proagents env verify staging
371
-
372
- # Sync environment variables
373
- proagents env sync --from development --to staging
374
-
375
- # Show environment status
376
- proagents env status production
377
-
378
- # Compare environments
379
- proagents env diff staging production
380
-
381
- # Export environment config
382
- proagents env export staging > staging-config.yaml
383
- ```
384
-
385
- ---
386
-
387
- ## Troubleshooting
388
-
389
- ### Common Issues
390
-
391
- | Issue | Cause | Solution |
392
- |-------|-------|----------|
393
- | Database connection failed | Wrong credentials | Verify DATABASE_URL |
394
- | Service unavailable | Container not running | Check docker-compose logs |
395
- | SSL errors | Certificate mismatch | Update certificates |
396
- | Slow performance | Resource limits | Increase CPU/memory |
397
-
398
- ### Health Checks
399
-
400
- ```bash
401
- # Check all services
402
- proagents env health development
403
-
404
- # Check specific service
405
- proagents env health staging --service api
406
-
407
- # Detailed diagnostics
408
- proagents env diagnose production
409
- ```
410
-
411
- ---
412
-
413
- ## Best Practices
414
-
415
- 1. **Parity**: Keep environments as similar as possible
416
- 2. **Secrets**: Never commit secrets to version control
417
- 3. **Infrastructure as Code**: Version control all configurations
418
- 4. **Documentation**: Document environment-specific quirks
419
- 5. **Access Control**: Restrict production access
420
- 6. **Monitoring**: Monitor all environments, not just production
@@ -1,55 +0,0 @@
1
- # Examples
2
-
3
- Complete workflow examples for different project types.
4
-
5
- ---
6
-
7
- ## Overview
8
-
9
- Real-world examples showing how to use ProAgents for different project types and scenarios.
10
-
11
- ## Project Type Examples
12
-
13
- | Example | Description |
14
- |---------|-------------|
15
- | [Web Frontend (React)](./web-frontend-react/) | React SPA with component library |
16
- | [Full-Stack (Next.js)](./fullstack-nextjs/) | Next.js with API routes |
17
- | [Mobile (React Native)](./mobile-react-native/) | Cross-platform mobile app |
18
- | [Backend (Node.js)](./backend-nodejs/) | Express/Node.js API |
19
-
20
- ## Each Example Includes
21
-
22
- - Complete workflow walkthrough
23
- - Phase-by-phase breakdown
24
- - Sample prompts and outputs
25
- - Configuration examples
26
- - Common patterns
27
-
28
- ## Conversation Examples
29
-
30
- See how ProAgents works in practice with full AI-user conversation examples:
31
-
32
- | Example | Feature Built |
33
- |---------|---------------|
34
- | [React Conversation](./web-frontend-react/complete-conversation.md) | Notifications system with real-time updates |
35
- | [Node.js Conversation](./backend-nodejs/complete-conversation.md) | Tiered rate limiting system |
36
-
37
- These show the actual back-and-forth interaction between user and AI.
38
-
39
- ## Using Examples
40
-
41
- ```bash
42
- # View example for your project type
43
- proagents example show react
44
-
45
- # Initialize ProAgents
46
- npx proagents init
47
- ```
48
-
49
- ## Contributing Examples
50
-
51
- To add a new example:
52
- 1. Create directory: `examples/[type]/`
53
- 2. Add `workflow-example.md`
54
- 3. Include sample configs
55
- 4. Document all phases
@@ -1,188 +0,0 @@
1
- # Backend Node.js Example
2
-
3
- Complete walkthrough of ProAgents workflow for a Node.js backend API service.
4
-
5
- ---
6
-
7
- ## Overview
8
-
9
- This example demonstrates how to use ProAgents to build features in a Node.js backend application. It covers API design, database operations, authentication, and service architecture.
10
-
11
- ---
12
-
13
- ## Project Type
14
-
15
- - **Runtime:** Node.js 18+
16
- - **Framework:** Express / Fastify
17
- - **Language:** TypeScript
18
- - **Database:** PostgreSQL + Prisma
19
- - **Testing:** Vitest + Supertest
20
-
21
- ---
22
-
23
- ## Files in This Example
24
-
25
- | File | Description |
26
- |------|-------------|
27
- | [workflow-example.md](./workflow-example.md) | Step-by-step workflow phases |
28
- | [complete-conversation.md](./complete-conversation.md) | Full AI conversation example |
29
- | [proagents.config.yaml](./proagents.config.yaml) | Project-specific configuration |
30
-
31
- ---
32
-
33
- ## What You'll Learn
34
-
35
- ### 1. Backend Analysis
36
- - Understanding service architecture
37
- - API endpoint mapping
38
- - Database schema analysis
39
- - Middleware and authentication flows
40
-
41
- ### 2. API Design
42
- - RESTful endpoint design
43
- - Request/response schemas (Zod)
44
- - Error handling patterns
45
- - API documentation (OpenAPI)
46
-
47
- ### 3. Implementation
48
- - Controller and service layers
49
- - Database operations
50
- - Input validation
51
- - Error handling and logging
52
-
53
- ### 4. Testing
54
- - Unit tests for services
55
- - Integration tests for API routes
56
- - Database testing with transactions
57
- - 85% coverage target for backend
58
-
59
- ---
60
-
61
- ## Quick Start
62
-
63
- ```bash
64
- # Copy configuration to your Node.js project
65
- cp proagents.config.yaml /path/to/your/nodejs-project/
66
-
67
- # Start a new feature
68
- proagents feature start "Add user preferences API"
69
- ```
70
-
71
- ---
72
-
73
- ## Example Feature: Preferences API
74
-
75
- The complete-conversation.md shows building a preferences API:
76
- - CRUD endpoints for user preferences
77
- - Database schema and migrations
78
- - Input validation with Zod
79
- - Comprehensive error handling
80
-
81
- ---
82
-
83
- ## Key Patterns Demonstrated
84
-
85
- ### Project Structure
86
- ```
87
- src/
88
- ├── controllers/ # Request handlers
89
- │ └── users.controller.ts
90
- ├── services/ # Business logic
91
- │ └── users.service.ts
92
- ├── models/ # Database models
93
- │ └── user.model.ts
94
- ├── routes/ # Route definitions
95
- │ └── users.routes.ts
96
- ├── middleware/ # Express middleware
97
- │ ├── auth.ts
98
- │ ├── validation.ts
99
- │ └── error-handler.ts
100
- ├── schemas/ # Zod validation schemas
101
- │ └── user.schema.ts
102
- ├── utils/ # Utilities
103
- └── types/ # TypeScript types
104
- ```
105
-
106
- ### Layered Architecture
107
- ```
108
- Request → Route → Controller → Service → Database
109
-
110
- Validation
111
-
112
- Response
113
- ```
114
-
115
- ---
116
-
117
- ## Configuration Highlights
118
-
119
- ```yaml
120
- # From proagents.config.yaml
121
- project:
122
- type: "backend"
123
- framework: "express"
124
-
125
- database:
126
- orm: "prisma"
127
- require_migrations: true
128
-
129
- api:
130
- versioning: "url" # /api/v1/...
131
- documentation: "openapi"
132
-
133
- testing:
134
- framework: "vitest"
135
- coverage_threshold: 85
136
- integration_tests: true
137
-
138
- security:
139
- scan_dependencies: true
140
- require_auth_review: true
141
-
142
- checkpoints:
143
- after_analysis: true # Review existing patterns
144
- after_design: true # Review API design
145
- before_deployment: true # Security review
146
- ```
147
-
148
- ---
149
-
150
- ## API Design Workflow
151
-
152
- ```bash
153
- # ProAgents guides you through:
154
- 1. Define endpoint structure
155
- 2. Create Zod schemas for validation
156
- 3. Design error responses
157
- 4. Generate OpenAPI documentation
158
- 5. Implement with tests
159
- ```
160
-
161
- ---
162
-
163
- ## Security Considerations
164
-
165
- ### Authentication
166
- - JWT token validation
167
- - Role-based access control
168
- - Rate limiting
169
-
170
- ### Input Validation
171
- - Zod schema validation
172
- - SQL injection prevention
173
- - XSS protection
174
-
175
- ### Logging & Monitoring
176
- - Request logging
177
- - Error tracking
178
- - Performance metrics
179
-
180
- ---
181
-
182
- ## Related Resources
183
-
184
- - [Node.js Scaffolding Template](../../scaffolding/nodejs/)
185
- - [API Versioning Guide](../../api-versioning/)
186
- - [Database Migrations](../../database/)
187
- - [Security Scanning](../../security/)
188
- - [Contract Testing](../../contract-testing/)