aiwf 0.1.0 → 0.3.1

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 (163) hide show
  1. package/CHANGELOG.md +46 -0
  2. package/CLAUDE.md +19 -0
  3. package/LICENSE +1 -1
  4. package/README.ko.md +90 -62
  5. package/README.md +109 -62
  6. package/claude-code/{simone/.simone → aiwf/en/.aiwf}/01_PROJECT_DOCS/ARCHITECTURE.md +1 -1
  7. package/claude-code/{simone/.simone → aiwf/en/.aiwf}/02_REQUIREMENTS/M01_Backend_Setup/M01_milestone_meta.md +5 -1
  8. package/claude-code/{simone/.simone → aiwf/en/.aiwf}/02_REQUIREMENTS/M01_Backend_Setup/PRD_AMEND_01_Auth_Flow_Update.md +5 -1
  9. package/claude-code/{simone/.simone/03_SPRINTS/CLAUDE.MD → aiwf/en/.aiwf/03_SPRINTS/CLAUDE.md} +28 -7
  10. package/claude-code/{simone/.simone → aiwf/en/.aiwf}/03_SPRINTS/S01_M01_Initial_API/S01_sprint_meta.md +8 -1
  11. package/claude-code/{simone/.simone → aiwf/en/.aiwf}/03_SPRINTS/S01_M01_Initial_API/T01_S01_Setup_Project_Structure.md +5 -1
  12. package/claude-code/aiwf/en/.aiwf/04_GENERAL_TASKS/CLAUDE.md +96 -0
  13. package/claude-code/{simone/.simone → aiwf/en/.aiwf}/04_GENERAL_TASKS/T002_API_Rate_Limiting.md +7 -2
  14. package/claude-code/{simone/.simone → aiwf/en/.aiwf}/04_GENERAL_TASKS/TX001_Refactor_Logging_Module.md +7 -2
  15. package/claude-code/{simone/.simone → aiwf/en/.aiwf}/05_ARCHITECTURAL_DECISIONS/ADR001_Chosen_Database_System.md +7 -1
  16. package/claude-code/{simone/.simone → aiwf/en/.aiwf}/05_ARCHITECTURAL_DECISIONS/ADR002_API_Authentication_Method.md +7 -1
  17. package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/2025-06-12-12-00-needs-focus.md +139 -0
  18. package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/2025-06-12-12-00-test-alignment.md +155 -0
  19. package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/2025-06-13-00-50-solid-progress.md +122 -0
  20. package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/2025-06-14-08-30-infrastructure-challenges.md +141 -0
  21. package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/2025-06-16-21-48-critical-foundation-issues.md +177 -0
  22. package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/2025-06-17-15-08-solid-progress.md +149 -0
  23. package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/index.json +5 -0
  24. package/claude-code/aiwf/en/.aiwf/10_STATE_OF_PROJECT/sync-index.js +78 -0
  25. package/claude-code/aiwf/en/.aiwf/98_PROMPTS/github_integration.md +130 -0
  26. package/claude-code/aiwf/en/.aiwf/98_PROMPTS/useful-prompts.md +31 -0
  27. package/claude-code/aiwf/en/.aiwf/98_PROMPTS/vibe-front-prompts.md +89 -0
  28. package/claude-code/{simone/.simone → aiwf/en/.aiwf}/99_TEMPLATES/task_template.md +1 -0
  29. package/claude-code/{simone/.simone/CLAUDE.MD → aiwf/en/.aiwf/CLAUDE.md} +13 -4
  30. package/claude-code/{simone/.simone → aiwf/en/.aiwf}/README.md +6 -6
  31. package/claude-code/aiwf/en/.claude/CLAUDE_BE.md +276 -0
  32. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_changelog.md +82 -0
  33. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_code_review.md +88 -0
  34. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_commit.md +160 -0
  35. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_create_general_task.md +147 -0
  36. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_create_milestone_plan.md +194 -0
  37. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_create_prd.md +272 -0
  38. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_create_sprint_tasks.md +189 -0
  39. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_create_sprints_from_milestone.md +121 -0
  40. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_discuss_review.md +29 -0
  41. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_do_task.md +109 -0
  42. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_docs.md +225 -0
  43. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_infinite.md +202 -0
  44. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_initialize.md +134 -0
  45. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_issue_create.md +65 -0
  46. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_language_manager.md +287 -0
  47. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_language_status.md +246 -0
  48. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_mermaid.md +272 -0
  49. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_pr_create.md +76 -0
  50. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_prime.md +9 -0
  51. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_project_review.md +261 -0
  52. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_switch_language.md +160 -0
  53. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_test.md +125 -0
  54. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_testing_review.md +198 -0
  55. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_tm-run-all-subtask.md +206 -0
  56. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_ultrathink_code_advanced.md +460 -0
  57. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_ultrathink_code_basic.md +165 -0
  58. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_ultrathink_general.md +362 -0
  59. package/claude-code/aiwf/en/.claude/commands/aiwf/aiwf_yolo.md +300 -0
  60. package/claude-code/aiwf/en/.claude/mcp.json +31 -0
  61. package/claude-code/aiwf/en/.claude/settings.json +102 -0
  62. package/claude-code/aiwf/ko/.aiwf/00_PROJECT_MANIFEST.md +49 -0
  63. package/claude-code/aiwf/ko/.aiwf/01_PROJECT_DOCS/ARCHITECTURE.md +55 -0
  64. package/claude-code/aiwf/ko/.aiwf/02_REQUIREMENTS/CLAUDE.md +78 -0
  65. package/claude-code/aiwf/ko/.aiwf/02_REQUIREMENTS/M01_Backend_Setup/M01_milestone_meta.md +42 -0
  66. package/claude-code/aiwf/ko/.aiwf/02_REQUIREMENTS/M01_Backend_Setup/PRD_AMEND_01_Auth_Flow_Update.md +73 -0
  67. package/claude-code/aiwf/ko/.aiwf/02_REQUIREMENTS/M01_Backend_Setup/PRD_Backend_Setup.md +98 -0
  68. package/claude-code/aiwf/ko/.aiwf/02_REQUIREMENTS/M01_Backend_Setup/SPECS_API_V1.md +232 -0
  69. package/claude-code/aiwf/ko/.aiwf/03_SPRINTS/CLAUDE.md +83 -0
  70. package/claude-code/aiwf/ko/.aiwf/03_SPRINTS/S01_M01_Initial_API/S01_sprint_meta.md +49 -0
  71. package/claude-code/aiwf/ko/.aiwf/03_SPRINTS/S01_M01_Initial_API/T01_S01_Setup_Project_Structure.md +60 -0
  72. package/claude-code/aiwf/ko/.aiwf/04_GENERAL_TASKS/CLAUDE.md +96 -0
  73. package/claude-code/aiwf/ko/.aiwf/04_GENERAL_TASKS/T002_API_Rate_Limiting.md +54 -0
  74. package/claude-code/aiwf/ko/.aiwf/04_GENERAL_TASKS/TX001_Refactor_Logging_Module.md +58 -0
  75. package/claude-code/aiwf/ko/.aiwf/05_ARCHITECTURAL_DECISIONS/ADR001_Chosen_Database_System.md +119 -0
  76. package/claude-code/aiwf/ko/.aiwf/05_ARCHITECTURAL_DECISIONS/ADR002_API_Authentication_Method.md +124 -0
  77. package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/2025-06-12-12-00-needs-focus.md +139 -0
  78. package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/2025-06-12-12-00-test-alignment.md +155 -0
  79. package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/2025-06-13-00-50-solid-progress.md +122 -0
  80. package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/2025-06-14-08-30-infrastructure-challenges.md +141 -0
  81. package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/2025-06-16-21-48-critical-foundation-issues.md +177 -0
  82. package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/2025-06-17-15-08-solid-progress.md +149 -0
  83. package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/index.json +5 -0
  84. package/claude-code/aiwf/ko/.aiwf/10_STATE_OF_PROJECT/sync-index.js +78 -0
  85. package/claude-code/aiwf/ko/.aiwf/98_PROMPTS/github_integration.md +130 -0
  86. package/claude-code/aiwf/ko/.aiwf/98_PROMPTS/useful-prompts.md +31 -0
  87. package/claude-code/aiwf/ko/.aiwf/98_PROMPTS/vibe-front-prompts.md +89 -0
  88. package/claude-code/aiwf/ko/.aiwf/99_TEMPLATES/adr_template.md +49 -0
  89. package/claude-code/aiwf/ko/.aiwf/99_TEMPLATES/milestone_meta_template.md +25 -0
  90. package/claude-code/aiwf/ko/.aiwf/99_TEMPLATES/project_manifest_template.md +39 -0
  91. package/claude-code/aiwf/ko/.aiwf/99_TEMPLATES/sprint_meta_template.md +23 -0
  92. package/claude-code/aiwf/ko/.aiwf/99_TEMPLATES/task_template.md +36 -0
  93. package/claude-code/aiwf/ko/.aiwf/CLAUDE.md +76 -0
  94. package/claude-code/aiwf/ko/.aiwf/README.md +97 -0
  95. package/claude-code/aiwf/ko/.claude/CLAUDE_BE.md +276 -0
  96. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_changelog.md +82 -0
  97. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_code_review.md +88 -0
  98. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_commit.md +160 -0
  99. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_create_general_task.md +147 -0
  100. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_create_milestone_plan.md +194 -0
  101. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_create_prd.md +280 -0
  102. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_create_sprint_tasks.md +189 -0
  103. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_create_sprints_from_milestone.md +121 -0
  104. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_discuss_review.md +29 -0
  105. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_do_task.md +109 -0
  106. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_docs.md +225 -0
  107. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_infinite.md +202 -0
  108. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_initialize.md +134 -0
  109. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_issue_create.md +65 -0
  110. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_language_manager.md +287 -0
  111. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_language_status.md +246 -0
  112. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_mermaid.md +272 -0
  113. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_pr_create.md +76 -0
  114. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_prime.md +9 -0
  115. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_project_review.md +261 -0
  116. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_switch_language.md +160 -0
  117. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_test.md +124 -0
  118. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_testing_review.md +198 -0
  119. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_tm-run-all-subtask.md +210 -0
  120. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_ultrathink_code_advanced.md +460 -0
  121. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_ultrathink_code_basic.md +165 -0
  122. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_ultrathink_general.md +305 -0
  123. package/claude-code/aiwf/ko/.claude/commands/aiwf/aiwf_yolo.md +300 -0
  124. package/claude-code/aiwf/ko/.claude/mcp.json +31 -0
  125. package/claude-code/aiwf/ko/.claude/settings.json +102 -0
  126. package/{AI-WORKFLOW.md → docs/AI-WORKFLOW.ko.md} +38 -24
  127. package/docs/AI-WORKFLOW.md +299 -0
  128. package/docs/COMMANDS_GUIDE.ko.md +727 -0
  129. package/docs/COMMANDS_GUIDE.md +726 -0
  130. package/docs/CONTRIBUTING.md +406 -0
  131. package/docs/DEVELOPMENT_GUIDE.md +727 -0
  132. package/docs/Enhanced_Installation_Flow_Design.md +498 -0
  133. package/docs/PRD.ko.md +148 -0
  134. package/docs/PRD.md +150 -0
  135. package/docs/moonklabs-metadata-system-prd.md +127 -0
  136. package/index.js +1493 -122
  137. package/jest.config.js +4 -0
  138. package/language-cli.js +279 -0
  139. package/language-utils.js +330 -0
  140. package/package.json +23 -10
  141. package/scripts/validate-commands.cjs +338 -0
  142. package/scripts/validate-commands.js +254 -0
  143. package/tests/basic.test.js +62 -0
  144. package/tests/commands.test.js +127 -0
  145. package/tests/installer.test.js +129 -0
  146. package/tests/language-utils.test.js +271 -0
  147. package/COMMANDS_GUIDE.md +0 -462
  148. package/PRD.ko.md +0 -96
  149. package/PRD.md +0 -98
  150. package/claude-code/simone/.simone/04_GENERAL_TASKS/CLAUDE.MD +0 -51
  151. package/claude-code/simone/CHANGELOG.md +0 -71
  152. package/claude-code/simone/LICENSE +0 -21
  153. package/claude-code/simone/README.md +0 -219
  154. package/claude-code/simone/SYNC_GUIDE.md +0 -172
  155. package/claude-code/simone/sync-simone.sh +0 -138
  156. /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/00_PROJECT_MANIFEST.md +0 -0
  157. /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/02_REQUIREMENTS/CLAUDE.md +0 -0
  158. /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/02_REQUIREMENTS/M01_Backend_Setup/PRD_Backend_Setup.md +0 -0
  159. /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/02_REQUIREMENTS/M01_Backend_Setup/SPECS_API_V1.md +0 -0
  160. /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/99_TEMPLATES/adr_template.md +0 -0
  161. /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/99_TEMPLATES/milestone_meta_template.md +0 -0
  162. /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/99_TEMPLATES/project_manifest_template.md +0 -0
  163. /package/claude-code/{simone/.simone → aiwf/en/.aiwf}/99_TEMPLATES/sprint_meta_template.md +0 -0
@@ -0,0 +1,102 @@
1
+ {
2
+ "permissions": {
3
+ "allow": [
4
+ "Bash(deno task *)",
5
+ "Bash(npm run *)",
6
+ "Bash(cargo *)",
7
+ "Bash(go *)",
8
+ "Bash(git *)",
9
+ "Bash(git worktree *)",
10
+ "Bash(gh *)",
11
+ "Bash(docker *)",
12
+ "Bash(kubectl *)",
13
+ "Bash(terraform *)",
14
+ "Bash(rg *)",
15
+ "Bash(ripgrep *)",
16
+ "Bash(fd *)",
17
+ "Bash(fzf *)",
18
+ "Bash(bat *)",
19
+ "Bash(exa *)",
20
+ "Bash(eza *)",
21
+ "Bash(delta *)",
22
+ "Bash(zoxide *)",
23
+ "Bash(duf *)",
24
+ "Bash(htop *)",
25
+ "Bash(btop *)",
26
+ "Bash(jq *)",
27
+ "Bash(yq *)",
28
+ "Bash(hexyl *)",
29
+ "Bash(prettier *)",
30
+ "Bash(eslint *)",
31
+ "Bash(tsc *)",
32
+ "Bash(pnpm *)",
33
+ "Bash(yarn *)",
34
+ "Bash(mkdir -p /tmp/claude-scratch*)",
35
+ "Bash(touch /tmp/claude-*)",
36
+ "Bash(echo * > /tmp/claude-*)",
37
+ "Bash(cat /tmp/claude-*)"
38
+ ],
39
+ "deny": [
40
+ "Bash(rm -rf /)",
41
+ "Bash(:(){ :|:& };:)",
42
+ "Bash(dd if=/dev/zero of=/dev/*)",
43
+ "Bash(mkfs.*)",
44
+ "Bash(> /dev/sda*)"
45
+ ]
46
+ },
47
+ "env": {
48
+ "CLAUDE_CODE_ENABLE_TELEMETRY": "0",
49
+ "EDITOR": "zed",
50
+ "GIT_EDITOR": "zed --wait"
51
+ },
52
+ "preferredNotifChannel": "terminal_bell",
53
+ "verbose": true,
54
+ "cleanupPeriodDays": 90,
55
+ "includeCoAuthoredBy": false,
56
+ "hooks": {
57
+ "beforeFileEdit": [
58
+ {
59
+ "command": "npm run lint:fix --silent || true",
60
+ "description": "Auto lint fix before file edit"
61
+ }
62
+ ],
63
+ "afterFileEdit": [
64
+ {
65
+ "command": "prettier --write {file} || true",
66
+ "description": "Auto format after file edit"
67
+ }
68
+ ],
69
+ "beforeCommit": [
70
+ {
71
+ "command": "npm run lint || echo 'Lint check failed'",
72
+ "description": "Lint check before commit"
73
+ },
74
+ {
75
+ "command": "npm run test || echo 'Test failed'",
76
+ "description": "Run tests before commit"
77
+ }
78
+ ],
79
+ "Stop": [
80
+ {
81
+ "matcher": "",
82
+ "hooks": [
83
+ {
84
+ "type": "command",
85
+ "command": "afplay /System/Library/Sounds/Glass.aiff"
86
+ }
87
+ ]
88
+ }
89
+ ],
90
+ "PostToolUse": [
91
+ {
92
+ "matcher": "Write|Edit|MultiEdit",
93
+ "hooks": [
94
+ {
95
+ "type": "command",
96
+ "command": "aiwf_test"
97
+ }
98
+ ]
99
+ }
100
+ ]
101
+ }
102
+ }
@@ -0,0 +1,49 @@
1
+ ---
2
+ project_name: Your Project Name
3
+ current_milestone_id: M01
4
+ highest_sprint_in_milestone: S02
5
+ current_sprint_id: S01
6
+ status: active
7
+ last_updated: 2025-01-01 00:00:00
8
+ ---
9
+
10
+ # Project Manifest: Your Project Name
11
+
12
+ This manifest serves as the central reference point for the project. It tracks the current focus and links to key documentation.
13
+
14
+ ## 1. Project Vision & Overview
15
+
16
+ [Describe your project's core vision, purpose, and goals here. What problem does it solve? Who is it for? What makes it unique?]
17
+
18
+ This project follows a milestone-based development approach.
19
+
20
+ ## 2. Current Focus
21
+
22
+ - **Milestone:** M01 - [Your First Milestone Name]
23
+ - **Sprint:** S01 - [Current Sprint Focus]
24
+
25
+ ## 3. Sprints in Current Milestone
26
+
27
+ ### S01 [Sprint Name] (🚧 IN PROGRESS)
28
+
29
+ 🚧 [First deliverable or feature]
30
+ 📋 [Second deliverable or feature]
31
+ 📋 [Third deliverable or feature]
32
+
33
+ ### S02 [Sprint Name] (📋 PLANNED)
34
+
35
+ 📋 [First planned deliverable]
36
+ 📋 [Second planned deliverable]
37
+ 📋 [Third planned deliverable]
38
+
39
+ ## 4. Key Documentation
40
+
41
+ - [Architecture Documentation](./01_PROJECT_DOCS/ARCHITECTURE.md)
42
+ - [Current Milestone Requirements](./02_REQUIREMENTS/M01_[Milestone_Name]/)
43
+ - [General Tasks](./04_GENERAL_TASKS/)
44
+
45
+ ## 5. Quick Links
46
+
47
+ - **Current Sprint:** [S01 Sprint Folder](./03_SPRINTS/S01_M01_[Sprint_Name]/)
48
+ - **Active Tasks:** Check sprint folder for T##_S01_*.md files
49
+ - **Project Reviews:** [Latest Review](./10_STATE_OF_PROJECT/)
@@ -0,0 +1,55 @@
1
+ # Demo Project Architecture (EXAMPLE)
2
+
3
+ This document outlines the high-level architecture of the Demo Project. **This is an example document to demonstrate how architecture might be documented in the AIWF framework.**
4
+
5
+ ## System Overview
6
+
7
+ This is a demonstration of how a system architecture document might be structured. In a real project, this would contain actual architectural details.
8
+
9
+ ## Technical Architecture (Example)
10
+
11
+ ### Backend
12
+
13
+ - **API Layer**: Node.js with Express.js
14
+ - **Database**: MongoDB for primary data storage
15
+ - **Authentication**: JWT-based authentication with OAuth support
16
+ - **Caching**: Redis for performance optimization
17
+ - **Testing**: Jest for unit and integration testing
18
+
19
+ ### Frontend
20
+
21
+ - **Web Client**: React.js with TypeScript
22
+ - **Mobile Apps**: React Native for iOS and Android
23
+ - **State Management**: Redux for predictable state
24
+ - **UI Framework**: Material-UI for consistent design
25
+
26
+ ## System Components (Example)
27
+
28
+ 1. **Authentication Service**: Handles user signup, login, and session management
29
+ 2. **Project Management Service**: Manages projects, teams, and permissions
30
+ 3. **Task Service**: Core task CRUD operations and business logic
31
+ 4. **Notification Service**: Manages user notifications and alerts
32
+ 5. **Analytics Service**: Provides usage statistics and reporting
33
+
34
+ ## Data Flow (Example)
35
+
36
+ 1. Clients authenticate through the Authentication Service
37
+ 2. Authenticated requests are routed to the appropriate service
38
+ 3. Services interact with the database and return responses
39
+ 4. Real-time updates are pushed to clients via WebSockets
40
+
41
+ ## Deployment Architecture (Example)
42
+
43
+ The system is deployed using containerization with Docker and Kubernetes, providing:
44
+
45
+ - Horizontal scalability for handling load spikes
46
+ - High availability through multiple replicas
47
+ - Zero-downtime deployments
48
+ - Environment isolation (development, staging, production)
49
+
50
+ ## Security Considerations (Example)
51
+
52
+ - All API endpoints are protected with proper authentication
53
+ - Sensitive data is encrypted at rest and in transit
54
+ - Rate limiting is implemented to prevent abuse
55
+ - Regular security audits and penetration testing
@@ -0,0 +1,78 @@
1
+ # CLAUDE.md - Requirements Folder Structure Guide
2
+
3
+ ## Overview
4
+ This folder contains all project milestones and their associated requirements documentation. Each milestone represents a major project phase or feature set.
5
+
6
+ ## Milestone Naming Convention
7
+ **CRITICAL**: Milestone folders MUST follow this exact pattern:
8
+ ```
9
+ M##_Milestone_Name/
10
+ ```
11
+
12
+ - `M##` - Two-digit milestone number (M01, M02, etc.)
13
+ - `_` - Single underscore separator
14
+ - `Milestone_Name` - Descriptive name using underscores for spaces
15
+
16
+ ### Examples:
17
+ - ✅ `M01_Backend_Setup/`
18
+ - ✅ `M02_Frontend_UI/`
19
+ - ✅ `M03_Authentication_System/`
20
+ - ❌ `M1_Backend/` (missing leading zero)
21
+ - ❌ `M01-Backend-Setup/` (wrong separator)
22
+ - ❌ `Backend_Setup/` (missing M## prefix)
23
+
24
+ ## Milestone Structure
25
+ Each milestone folder MUST contain:
26
+
27
+ ### 1. Milestone Meta File (REQUIRED)
28
+ - **Name**: `M##_milestone_meta.md`
29
+ - **Purpose**: Contains milestone metadata and overview
30
+ - **Location**: Root of milestone folder
31
+
32
+ ### 2. Product Requirements Documents (PRD)
33
+ - **Pattern**: `PRD_*.md`
34
+ - **Examples**: `PRD_Backend_Setup.md`, `PRD_User_Authentication.md`
35
+ - **Purpose**: Define product requirements and user stories
36
+
37
+ ### 3. Technical Specifications
38
+ - **Pattern**: `SPECS_*.md`
39
+ - **Examples**: `SPECS_API_V1.md`, `SPECS_Database_Schema.md`
40
+ - **Purpose**: Technical implementation details
41
+
42
+ ### 4. Amendments (as needed)
43
+ - **Pattern**: `PRD_AMEND_##_*.md`
44
+ - **Examples**: `PRD_AMEND_01_Additional_Endpoints.md`
45
+ - **Purpose**: Document changes to original requirements
46
+
47
+ ## Example Structure
48
+ ```
49
+ 02_REQUIREMENTS/
50
+ ├── M01_Backend_Setup/
51
+ │ ├── M01_milestone_meta.md
52
+ │ ├── PRD_Backend_Setup.md
53
+ │ ├── SPECS_API_V1.md
54
+ │ └── PRD_AMEND_01_Cache_Layer.md
55
+ ├── M02_Frontend_UI/
56
+ │ ├── M02_milestone_meta.md
57
+ │ ├── PRD_User_Interface.md
58
+ │ └── SPECS_Component_Library.md
59
+ └── M03_Authentication_System/
60
+ ├── M03_milestone_meta.md
61
+ ├── PRD_Authentication.md
62
+ └── SPECS_OAuth_Integration.md
63
+ ```
64
+
65
+ ## Important Notes for Claude Code
66
+
67
+ 1. **Always use the M## prefix** when creating milestone folders
68
+ 2. **Use underscores** for spaces in milestone names
69
+ 3. **Create the milestone meta file first** using the template from `99_TEMPLATES/milestone_meta_template.md`
70
+ 4. **Update the project manifest** (`00_PROJECT_MANIFEST.md`) when creating new milestones
71
+ 5. **Maintain sequential numbering** - don't skip milestone numbers
72
+
73
+ ## Common Mistakes to Avoid
74
+ - Creating milestones without the M## prefix
75
+ - Using hyphens instead of underscores
76
+ - Forgetting the milestone meta file
77
+ - Not updating the project manifest
78
+ - Creating milestones in the wrong location (must be in 02_REQUIREMENTS)
@@ -0,0 +1,42 @@
1
+ ---
2
+ milestone_id: M01
3
+ title: Backend Setup
4
+ status: active # pending | active | completed | blocked | on_hold
5
+ last_updated: 2023-07-10
6
+ ---
7
+
8
+ # Milestone: Backend Setup (EXAMPLE)
9
+
10
+ ## Goals
11
+
12
+ This milestone focuses on establishing the core backend infrastructure for the project, including:
13
+
14
+ 1. Setting up the initial project structure
15
+ 2. Defining the database schema and models
16
+ 3. Implementing basic API endpoints
17
+ 4. Establishing authentication and authorization systems
18
+
19
+ ## Key Documents
20
+
21
+ - [Product Requirements Document](./PRD_Backend_Setup.md)
22
+ - [API Specifications V1](./SPECS_API_V1.md)
23
+ - [Auth Flow Update Amendment](./PRD_AMEND_01_Auth_Flow_Update.md)
24
+
25
+ ## Definition of Done (DoD)
26
+
27
+ This milestone will be considered complete when:
28
+
29
+ - The backend server can be started and responds to API requests
30
+ - All core models are defined and can be created/updated/deleted via the API
31
+ - Authentication is working with JWT tokens
32
+ - Basic error handling is implemented
33
+ - Integration tests are passing for all endpoints
34
+
35
+ ## Notes / Context
36
+
37
+ This is an example milestone document to demonstrate how milestones might be structured in a project using the AIWF framework. The backend infrastructure established here would be the foundation for a typical web application.
38
+
39
+ ## Related Sprints
40
+
41
+ - [S01_M01_Initial_API](../../03_SPRINTS/S01_M01_Initial_API/S01_sprint_meta.md)
42
+ - [S02_M01_Database_Integration](../../03_SPRINTS/S02_M01_Database_Integration/S02_sprint_meta.md)
@@ -0,0 +1,73 @@
1
+ # Amendment: Auth Flow Update (EXAMPLE)
2
+
3
+ ## Date: 2023-05-17
4
+
5
+ ## Overview
6
+
7
+ This amendment updates the authentication flow requirements to incorporate OAuth 2.0 support for social logins in addition to the existing email/password authentication.
8
+
9
+ **Note: This is an example amendment document to demonstrate how requirement changes might be tracked in the AIWF framework.**
10
+
11
+ ## Changes to Product Requirements
12
+
13
+ ### User Management (FR-1)
14
+
15
+ **Added Requirements:**
16
+
17
+ - FR-1.6: The system shall allow users to register and log in using Google OAuth
18
+ - FR-1.7: The system shall allow users to register and log in using GitHub OAuth
19
+ - FR-1.8: The system shall link social login accounts with existing email accounts when the email matches
20
+
21
+ ### Data Models (FR-2)
22
+
23
+ **Updated FR-2.1 (User model):**
24
+
25
+ Add the following fields to the User model:
26
+
27
+ - `oauth_provider`: string (null, 'google', 'github')
28
+ - `oauth_id`: string (provider-specific user ID)
29
+
30
+ ### API Endpoints (FR-3)
31
+
32
+ **Added Endpoints to FR-3.1:**
33
+
34
+ - GET /api/auth/oauth/google (Redirect URL for Google OAuth)
35
+ - GET /api/auth/oauth/github (Redirect URL for GitHub OAuth)
36
+ - GET /api/auth/oauth/callback (OAuth provider callback)
37
+
38
+ ## Changes to Non-Functional Requirements
39
+
40
+ **Updated NFR-5:**
41
+
42
+ - NFR-5: The system shall implement JWT-based authentication with support for OAuth 2.0 providers
43
+
44
+ **Added NFR:**
45
+
46
+ - NFR-9: The system shall securely store OAuth provider credentials in environment variables
47
+
48
+ ## Implementation Impact
49
+
50
+ - Required libraries: `passport`, `passport-google-oauth20`, `passport-github2`
51
+ - Additional environment variables needed:
52
+ - `GOOGLE_CLIENT_ID`
53
+ - `GOOGLE_CLIENT_SECRET`
54
+ - `GITHUB_CLIENT_ID`
55
+ - `GITHUB_CLIENT_SECRET`
56
+ - `OAUTH_CALLBACK_URL`
57
+
58
+ ## Test Cases
59
+
60
+ - TC-1: User can log in with Google account
61
+ - TC-2: User can log in with GitHub account
62
+ - TC-3: Social login with matching email links to existing account
63
+ - TC-4: JWT token works correctly regardless of authentication method
64
+
65
+ ## Timeline Impact
66
+
67
+ Implementation of these changes is expected to add 3 days to the original timeline.
68
+
69
+ ## Approvals
70
+
71
+ - Requested by: Sarah Chen (Product Manager)
72
+ - Approved by: Mike Johnson (Technical Lead)
73
+ - Approved by: David Lee (Project Manager)
@@ -0,0 +1,98 @@
1
+ # Product Requirements Document: Backend Setup
2
+
3
+ ## Overview
4
+
5
+ This document outlines the requirements for setting up the backend infrastructure for our application. The backend will provide API endpoints for client applications, handle data persistence, and implement business logic.
6
+
7
+ ## Functional Requirements
8
+
9
+ ### User Management
10
+
11
+ - FR-1.1: The system shall allow users to register with email and password
12
+ - FR-1.2: The system shall allow users to log in with their credentials
13
+ - FR-1.3: The system shall allow users to reset their password via email
14
+ - FR-1.4: The system shall allow users to update their profile information
15
+ - FR-1.5: The system shall allow administrators to disable user accounts
16
+
17
+ ### Data Models
18
+
19
+ - FR-2.1: The system shall implement a User model with fields for:
20
+ - Email (unique)
21
+ - Password (hashed)
22
+ - Profile information (name, avatar, etc.)
23
+ - Role (user, admin)
24
+ - Account status (active, disabled)
25
+
26
+ - FR-2.2: The system shall implement a Project model with fields for:
27
+ - Title
28
+ - Description
29
+ - Creation date
30
+ - Owner (User reference)
31
+ - Members (User references)
32
+ - Status (active, archived)
33
+
34
+ - FR-2.3: The system shall implement a Task model with fields for:
35
+ - Title
36
+ - Description
37
+ - Due date
38
+ - Assigned user (User reference)
39
+ - Project (Project reference)
40
+ - Status (todo, in_progress, done)
41
+ - Priority (low, medium, high)
42
+
43
+ ### API Endpoints
44
+
45
+ - FR-3.1: The system shall provide authentication endpoints:
46
+ - POST /api/auth/register
47
+ - POST /api/auth/login
48
+ - POST /api/auth/reset-password
49
+ - POST /api/auth/reset-password-confirm
50
+
51
+ - FR-3.2: The system shall provide user management endpoints:
52
+ - GET /api/users/me
53
+ - PUT /api/users/me
54
+ - GET /api/users (admin only)
55
+ - PUT /api/users/:id (admin only)
56
+
57
+ - FR-3.3: The system shall provide project management endpoints:
58
+ - GET /api/projects
59
+ - POST /api/projects
60
+ - GET /api/projects/:id
61
+ - PUT /api/projects/:id
62
+ - DELETE /api/projects/:id
63
+
64
+ - FR-3.4: The system shall provide task management endpoints:
65
+ - GET /api/projects/:id/tasks
66
+ - POST /api/projects/:id/tasks
67
+ - GET /api/tasks/:id
68
+ - PUT /api/tasks/:id
69
+ - DELETE /api/tasks/:id
70
+
71
+ ## Non-Functional Requirements
72
+
73
+ - NFR-1: The backend shall be implemented using Node.js and Express
74
+ - NFR-2: The system shall use MongoDB for data persistence
75
+ - NFR-3: API response time shall be under 200ms for 95% of requests
76
+ - NFR-4: The system shall handle up to 1000 concurrent users
77
+ - NFR-5: The system shall implement JWT-based authentication
78
+ - NFR-6: All API endpoints shall be documented using OpenAPI/Swagger
79
+ - NFR-7: The codebase shall have at least 80% test coverage
80
+ - NFR-8: The system shall log all errors and API requests
81
+
82
+ ## Constraints
83
+
84
+ - The backend must be deployable to AWS and Azure
85
+ - The system must comply with GDPR requirements for user data
86
+ - The API must be versioned to support future changes
87
+
88
+ ## Assumptions
89
+
90
+ - The client applications will be responsible for input validation
91
+ - The backend will be accessed only through the API, not directly
92
+ - The database will be hosted on a managed service (MongoDB Atlas)
93
+
94
+ ## Dependencies
95
+
96
+ - MongoDB Atlas account
97
+ - SMTP service for email sending
98
+ - JWT secret key management