@pixelbyte-software/pixcode 1.35.2 → 1.35.4
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/LICENSE +718 -718
- package/README.de.md +248 -248
- package/README.ja.md +240 -240
- package/README.ko.md +240 -240
- package/README.md +303 -303
- package/README.ru.md +248 -248
- package/README.tr.md +250 -250
- package/README.zh-CN.md +240 -240
- package/dist/api-docs.html +548 -548
- package/dist/assets/index-BwmhA_le.css +32 -0
- package/dist/assets/{index-D1-AIL_5.js → index-CyxRiNt0.js} +182 -182
- package/dist/clear-cache.html +85 -85
- package/dist/convert-icons.md +52 -52
- package/dist/favicon.svg +8 -8
- package/dist/generate-icons.js +48 -48
- package/dist/icons/codex-white.svg +3 -3
- package/dist/icons/codex.svg +3 -3
- package/dist/icons/cursor-white.svg +11 -11
- package/dist/icons/icon-128x128.svg +9 -9
- package/dist/icons/icon-144x144.svg +9 -9
- package/dist/icons/icon-152x152.svg +9 -9
- package/dist/icons/icon-192x192.svg +9 -9
- package/dist/icons/icon-384x384.svg +9 -9
- package/dist/icons/icon-512x512.svg +9 -9
- package/dist/icons/icon-72x72.svg +9 -9
- package/dist/icons/icon-96x96.svg +9 -9
- package/dist/icons/icon-template.svg +9 -9
- package/dist/icons/qwen-logo.svg +14 -14
- package/dist/index.html +59 -59
- package/dist/logo.svg +12 -12
- package/dist/manifest.json +60 -60
- package/dist/openapi.yaml +1693 -1693
- package/dist/sw.js +124 -124
- package/dist-server/server/cli.js +96 -96
- package/dist-server/server/cli.js.map +1 -1
- package/dist-server/server/cursor-cli.js.map +1 -1
- package/dist-server/server/daemon/manager.js +33 -33
- package/dist-server/server/daemon-manager.js +64 -64
- package/dist-server/server/gemini-cli.js +4 -4
- package/dist-server/server/gemini-cli.js.map +1 -1
- package/dist-server/server/index.js +11 -11
- package/dist-server/server/index.js.map +1 -1
- package/dist-server/server/load-env.js.map +1 -1
- package/dist-server/server/middleware/auth.js.map +1 -1
- package/dist-server/server/modules/orchestration/tasks/orchestration-task.routes.js.map +1 -1
- package/dist-server/server/modules/providers/list/claude/claude-auth.provider.js +1 -1
- package/dist-server/server/modules/providers/list/claude/claude-auth.provider.js.map +1 -1
- package/dist-server/server/modules/providers/list/codex/codex-auth.provider.js +1 -1
- package/dist-server/server/modules/providers/list/codex/codex-auth.provider.js.map +1 -1
- package/dist-server/server/modules/providers/list/gemini/gemini-auth.provider.js +1 -1
- package/dist-server/server/modules/providers/list/gemini/gemini-auth.provider.js.map +1 -1
- package/dist-server/server/modules/providers/list/opencode/opencode-auth.provider.js +1 -1
- package/dist-server/server/modules/providers/list/opencode/opencode-auth.provider.js.map +1 -1
- package/dist-server/server/modules/providers/list/qwen/qwen-auth.provider.js +1 -1
- package/dist-server/server/modules/providers/list/qwen/qwen-auth.provider.js.map +1 -1
- package/dist-server/server/modules/providers/provider.routes.js +3 -6
- package/dist-server/server/modules/providers/provider.routes.js.map +1 -1
- package/dist-server/server/opencode-cli.js +1 -1
- package/dist-server/server/opencode-cli.js.map +1 -1
- package/dist-server/server/projects.js +2 -3
- package/dist-server/server/projects.js.map +1 -1
- package/dist-server/server/qwen-code-cli.js +1 -1
- package/dist-server/server/qwen-code-cli.js.map +1 -1
- package/dist-server/server/routes/agent.js +3 -3
- package/dist-server/server/routes/agent.js.map +1 -1
- package/dist-server/server/routes/auth.js.map +1 -1
- package/dist-server/server/routes/codex.js.map +1 -1
- package/dist-server/server/routes/commands.js +26 -26
- package/dist-server/server/routes/commands.js.map +1 -1
- package/dist-server/server/routes/cursor.js +1 -1
- package/dist-server/server/routes/cursor.js.map +1 -1
- package/dist-server/server/routes/gemini.js.map +1 -1
- package/dist-server/server/routes/git.js +18 -18
- package/dist-server/server/routes/git.js.map +1 -1
- package/dist-server/server/routes/mcp-utils.js.map +1 -1
- package/dist-server/server/routes/messages.js.map +1 -1
- package/dist-server/server/routes/network.js +1 -1
- package/dist-server/server/routes/network.js.map +1 -1
- package/dist-server/server/routes/plugins.js +2 -2
- package/dist-server/server/routes/plugins.js.map +1 -1
- package/dist-server/server/routes/projects.js +1 -1
- package/dist-server/server/routes/projects.js.map +1 -1
- package/dist-server/server/routes/settings.js.map +1 -1
- package/dist-server/server/routes/taskmaster.js +423 -424
- package/dist-server/server/routes/taskmaster.js.map +1 -1
- package/dist-server/server/routes/user.js +1 -1
- package/dist-server/server/routes/user.js.map +1 -1
- package/dist-server/server/services/external-access.js +0 -1
- package/dist-server/server/services/external-access.js.map +1 -1
- package/dist-server/server/services/notification-orchestrator.js.map +1 -1
- package/dist-server/server/utils/commandParser.js.map +1 -1
- package/dist-server/server/utils/plugin-process-manager.js.map +1 -1
- package/dist-server/server/vite-daemon.js.map +1 -1
- package/package.json +180 -180
- package/scripts/fix-node-pty.js +67 -67
- package/scripts/smoke/a2a-roundtrip.mjs +167 -167
- package/scripts/smoke/orchestration-api.mjs +172 -172
- package/scripts/smoke/orchestration-live-run.mjs +176 -176
- package/server/claude-sdk.js +898 -898
- package/server/cli.js +936 -935
- package/server/constants/config.js +4 -4
- package/server/cursor-cli.js +344 -342
- package/server/daemon/manager.js +564 -564
- package/server/daemon-manager.js +959 -959
- package/server/database/db.js +794 -794
- package/server/database/json-store.js +197 -197
- package/server/gemini-cli.js +536 -535
- package/server/gemini-response-handler.js +79 -79
- package/server/index.js +3138 -3135
- package/server/load-env.js +35 -34
- package/server/middleware/auth.js +174 -173
- package/server/modules/orchestration/a2a/adapter-registry.ts +108 -108
- package/server/modules/orchestration/a2a/adapters/abstract-a2a.adapter.ts +55 -55
- package/server/modules/orchestration/a2a/adapters/claude-code.adapter.ts +284 -284
- package/server/modules/orchestration/a2a/adapters/codex.adapter.ts +244 -244
- package/server/modules/orchestration/a2a/adapters/cursor.adapter.ts +249 -249
- package/server/modules/orchestration/a2a/adapters/gemini.adapter.ts +248 -248
- package/server/modules/orchestration/a2a/adapters/opencode.adapter.ts +248 -248
- package/server/modules/orchestration/a2a/adapters/qwen.adapter.ts +248 -248
- package/server/modules/orchestration/a2a/routes.ts +577 -577
- package/server/modules/orchestration/a2a/task-store.ts +178 -178
- package/server/modules/orchestration/a2a/types.ts +125 -125
- package/server/modules/orchestration/a2a/validator.ts +113 -113
- package/server/modules/orchestration/index.ts +66 -66
- package/server/modules/orchestration/preview/port-watcher.ts +112 -112
- package/server/modules/orchestration/preview/preview-proxy.ts +60 -60
- package/server/modules/orchestration/preview/types.ts +19 -19
- package/server/modules/orchestration/tasks/orchestration-task-store.ts +45 -45
- package/server/modules/orchestration/tasks/orchestration-task.routes.ts +74 -73
- package/server/modules/orchestration/tasks/orchestration-task.service.ts +145 -145
- package/server/modules/orchestration/tasks/orchestration-task.types.ts +29 -29
- package/server/modules/orchestration/workflows/built-in-workflows.ts +127 -127
- package/server/modules/orchestration/workflows/workflow-runner.ts +1206 -1206
- package/server/modules/orchestration/workflows/workflow-store.ts +97 -97
- package/server/modules/orchestration/workflows/workflow.routes.ts +169 -169
- package/server/modules/orchestration/workflows/workflow.types.ts +70 -70
- package/server/modules/orchestration/workflows/workspace-target.ts +120 -120
- package/server/modules/orchestration/workspace/docker-workspace.ts +135 -135
- package/server/modules/orchestration/workspace/path-safety.ts +55 -55
- package/server/modules/orchestration/workspace/types.ts +52 -52
- package/server/modules/orchestration/workspace/workspace-manager.ts +97 -97
- package/server/modules/orchestration/workspace/worktree-workspace.ts +125 -125
- package/server/modules/providers/index.ts +2 -2
- package/server/modules/providers/list/claude/claude-auth.provider.ts +146 -145
- package/server/modules/providers/list/claude/claude-mcp.provider.ts +135 -135
- package/server/modules/providers/list/claude/claude-sessions.provider.ts +306 -306
- package/server/modules/providers/list/claude/claude.provider.ts +15 -15
- package/server/modules/providers/list/codex/codex-auth.provider.ts +116 -115
- package/server/modules/providers/list/codex/codex-mcp.provider.ts +135 -135
- package/server/modules/providers/list/codex/codex-sessions.provider.ts +319 -319
- package/server/modules/providers/list/codex/codex.provider.ts +15 -15
- package/server/modules/providers/list/cursor/cursor-auth.provider.ts +143 -143
- package/server/modules/providers/list/cursor/cursor-mcp.provider.ts +108 -108
- package/server/modules/providers/list/cursor/cursor-sessions.provider.ts +421 -421
- package/server/modules/providers/list/cursor/cursor.provider.ts +15 -15
- package/server/modules/providers/list/gemini/gemini-auth.provider.ts +164 -163
- package/server/modules/providers/list/gemini/gemini-mcp.provider.ts +110 -110
- package/server/modules/providers/list/gemini/gemini-sessions.provider.ts +227 -227
- package/server/modules/providers/list/gemini/gemini.provider.ts +15 -15
- package/server/modules/providers/list/opencode/opencode-auth.provider.ts +131 -130
- package/server/modules/providers/list/opencode/opencode-mcp.provider.ts +126 -126
- package/server/modules/providers/list/opencode/opencode-sessions.provider.ts +232 -232
- package/server/modules/providers/list/opencode/opencode.provider.ts +29 -29
- package/server/modules/providers/list/qwen/qwen-auth.provider.ts +146 -145
- package/server/modules/providers/list/qwen/qwen-mcp.provider.ts +114 -114
- package/server/modules/providers/list/qwen/qwen-sessions.provider.ts +265 -265
- package/server/modules/providers/list/qwen/qwen.provider.ts +21 -21
- package/server/modules/providers/provider.registry.ts +40 -40
- package/server/modules/providers/provider.routes.ts +822 -819
- package/server/modules/providers/services/mcp.service.ts +86 -86
- package/server/modules/providers/services/provider-auth.service.ts +26 -26
- package/server/modules/providers/services/sessions.service.ts +45 -45
- package/server/modules/providers/shared/base/abstract.provider.ts +20 -20
- package/server/modules/providers/shared/mcp/mcp.provider.ts +151 -151
- package/server/modules/providers/shared/provider-configs.ts +142 -142
- package/server/modules/providers/tests/mcp.test.ts +293 -293
- package/server/openai-codex.js +462 -462
- package/server/opencode-cli.js +460 -459
- package/server/opencode-response-handler.js +107 -107
- package/server/projects.js +3106 -3105
- package/server/qwen-code-cli.js +396 -395
- package/server/qwen-response-handler.js +73 -73
- package/server/routes/agent.js +1367 -1365
- package/server/routes/auth.js +139 -138
- package/server/routes/codex.js +20 -19
- package/server/routes/commands.js +556 -554
- package/server/routes/cursor.js +54 -52
- package/server/routes/gemini.js +25 -24
- package/server/routes/git.js +1490 -1488
- package/server/routes/mcp-utils.js +32 -31
- package/server/routes/messages.js +62 -61
- package/server/routes/network.js +121 -120
- package/server/routes/plugins.js +320 -318
- package/server/routes/projects.js +917 -915
- package/server/routes/qwen.js +27 -27
- package/server/routes/settings.js +287 -286
- package/server/routes/taskmaster.js +1498 -1496
- package/server/routes/telegram.js +125 -125
- package/server/routes/user.js +125 -123
- package/server/services/external-access.js +171 -171
- package/server/services/install-jobs.js +571 -571
- package/server/services/notification-orchestrator.js +244 -242
- package/server/services/provider-credentials.js +189 -189
- package/server/services/provider-models.js +381 -381
- package/server/services/telegram/bot.js +279 -279
- package/server/services/telegram/telegram-http-client.js +130 -130
- package/server/services/telegram/translations.js +170 -170
- package/server/services/vapid-keys.js +36 -36
- package/server/sessionManager.js +225 -225
- package/server/shared/interfaces.ts +54 -54
- package/server/shared/types.ts +172 -172
- package/server/shared/utils.ts +193 -193
- package/server/tsconfig.json +36 -36
- package/server/utils/colors.js +21 -21
- package/server/utils/commandParser.js +305 -303
- package/server/utils/frontmatter.js +18 -18
- package/server/utils/gitConfig.js +34 -34
- package/server/utils/mcp-detector.js +147 -147
- package/server/utils/plugin-loader.js +457 -457
- package/server/utils/plugin-process-manager.js +185 -184
- package/server/utils/port-access.js +209 -209
- package/server/utils/runtime-paths.js +37 -37
- package/server/utils/taskmaster-websocket.js +128 -128
- package/server/utils/url-detection.js +71 -71
- package/server/vite-daemon.js +79 -78
- package/shared/modelConstants.js +162 -162
- package/shared/networkHosts.js +22 -22
- package/dist/assets/index-B8w57E1r.css +0 -32
|
@@ -7,15 +7,14 @@
|
|
|
7
7
|
* - MCP server configuration detection
|
|
8
8
|
* - TaskMaster state and metadata management
|
|
9
9
|
*/
|
|
10
|
-
import
|
|
11
|
-
import fs from 'fs';
|
|
10
|
+
import fs, { promises as fsPromises } from 'fs';
|
|
12
11
|
import path from 'path';
|
|
13
|
-
import { promises as fsPromises } from 'fs';
|
|
14
12
|
import { spawn } from 'child_process';
|
|
13
|
+
import express from 'express';
|
|
14
|
+
import { orchestrationTaskService } from '../modules/orchestration/tasks/orchestration-task.service.js';
|
|
15
15
|
import { extractProjectDirectory } from '../projects.js';
|
|
16
|
-
import { detectTaskMasterMCPServer } from '../utils/mcp-detector.js';
|
|
17
16
|
import { broadcastTaskMasterProjectUpdate, broadcastTaskMasterTasksUpdate } from '../utils/taskmaster-websocket.js';
|
|
18
|
-
import {
|
|
17
|
+
import { detectTaskMasterMCPServer } from '../utils/mcp-detector.js';
|
|
19
18
|
const router = express.Router();
|
|
20
19
|
/**
|
|
21
20
|
* Check if TaskMaster CLI is installed globally
|
|
@@ -836,74 +835,74 @@ router.get('/prd-templates', async (req, res) => {
|
|
|
836
835
|
name: 'Web Application',
|
|
837
836
|
description: 'Template for web application projects with frontend and backend components',
|
|
838
837
|
category: 'web',
|
|
839
|
-
content: `# Product Requirements Document - Web Application
|
|
840
|
-
|
|
841
|
-
## Overview
|
|
842
|
-
**Product Name:** [Your App Name]
|
|
843
|
-
**Version:** 1.0
|
|
844
|
-
**Date:** ${new Date().toISOString().split('T')[0]}
|
|
845
|
-
**Author:** [Your Name]
|
|
846
|
-
|
|
847
|
-
## Executive Summary
|
|
848
|
-
Brief description of what this web application will do and why it's needed.
|
|
849
|
-
|
|
850
|
-
## Product Goals
|
|
851
|
-
- Goal 1: [Specific measurable goal]
|
|
852
|
-
- Goal 2: [Specific measurable goal]
|
|
853
|
-
- Goal 3: [Specific measurable goal]
|
|
854
|
-
|
|
855
|
-
## User Stories
|
|
856
|
-
### Core Features
|
|
857
|
-
1. **User Registration & Authentication**
|
|
858
|
-
- As a user, I want to create an account so I can access personalized features
|
|
859
|
-
- As a user, I want to log in securely so my data is protected
|
|
860
|
-
- As a user, I want to reset my password if I forget it
|
|
861
|
-
|
|
862
|
-
2. **Main Application Features**
|
|
863
|
-
- As a user, I want to [core feature 1] so I can [benefit]
|
|
864
|
-
- As a user, I want to [core feature 2] so I can [benefit]
|
|
865
|
-
- As a user, I want to [core feature 3] so I can [benefit]
|
|
866
|
-
|
|
867
|
-
3. **User Interface**
|
|
868
|
-
- As a user, I want a responsive design so I can use the app on any device
|
|
869
|
-
- As a user, I want intuitive navigation so I can easily find features
|
|
870
|
-
|
|
871
|
-
## Technical Requirements
|
|
872
|
-
### Frontend
|
|
873
|
-
- Framework: React/Vue/Angular or vanilla JavaScript
|
|
874
|
-
- Styling: CSS framework (Tailwind, Bootstrap, etc.)
|
|
875
|
-
- State Management: Redux/Vuex/Context API
|
|
876
|
-
- Build Tools: Webpack/Vite
|
|
877
|
-
- Testing: Jest/Vitest for unit tests
|
|
878
|
-
|
|
879
|
-
### Backend
|
|
880
|
-
- Runtime: Node.js/Python/Java
|
|
881
|
-
- Database: PostgreSQL/MySQL/MongoDB
|
|
882
|
-
- API: RESTful API or GraphQL
|
|
883
|
-
- Authentication: JWT tokens
|
|
884
|
-
- Testing: Integration and unit tests
|
|
885
|
-
|
|
886
|
-
### Infrastructure
|
|
887
|
-
- Hosting: Cloud provider (AWS, Azure, GCP)
|
|
888
|
-
- CI/CD: GitHub Actions/GitLab CI
|
|
889
|
-
- Monitoring: Application monitoring tools
|
|
890
|
-
- Security: HTTPS, input validation, rate limiting
|
|
891
|
-
|
|
892
|
-
## Success Metrics
|
|
893
|
-
- User engagement metrics
|
|
894
|
-
- Performance benchmarks (load time < 2s)
|
|
895
|
-
- Error rates < 1%
|
|
896
|
-
- User satisfaction scores
|
|
897
|
-
|
|
898
|
-
## Timeline
|
|
899
|
-
- Phase 1: Core functionality (4-6 weeks)
|
|
900
|
-
- Phase 2: Advanced features (2-4 weeks)
|
|
901
|
-
- Phase 3: Polish and launch (2 weeks)
|
|
902
|
-
|
|
903
|
-
## Constraints & Assumptions
|
|
904
|
-
- Budget constraints
|
|
905
|
-
- Technical limitations
|
|
906
|
-
- Team size and expertise
|
|
838
|
+
content: `# Product Requirements Document - Web Application
|
|
839
|
+
|
|
840
|
+
## Overview
|
|
841
|
+
**Product Name:** [Your App Name]
|
|
842
|
+
**Version:** 1.0
|
|
843
|
+
**Date:** ${new Date().toISOString().split('T')[0]}
|
|
844
|
+
**Author:** [Your Name]
|
|
845
|
+
|
|
846
|
+
## Executive Summary
|
|
847
|
+
Brief description of what this web application will do and why it's needed.
|
|
848
|
+
|
|
849
|
+
## Product Goals
|
|
850
|
+
- Goal 1: [Specific measurable goal]
|
|
851
|
+
- Goal 2: [Specific measurable goal]
|
|
852
|
+
- Goal 3: [Specific measurable goal]
|
|
853
|
+
|
|
854
|
+
## User Stories
|
|
855
|
+
### Core Features
|
|
856
|
+
1. **User Registration & Authentication**
|
|
857
|
+
- As a user, I want to create an account so I can access personalized features
|
|
858
|
+
- As a user, I want to log in securely so my data is protected
|
|
859
|
+
- As a user, I want to reset my password if I forget it
|
|
860
|
+
|
|
861
|
+
2. **Main Application Features**
|
|
862
|
+
- As a user, I want to [core feature 1] so I can [benefit]
|
|
863
|
+
- As a user, I want to [core feature 2] so I can [benefit]
|
|
864
|
+
- As a user, I want to [core feature 3] so I can [benefit]
|
|
865
|
+
|
|
866
|
+
3. **User Interface**
|
|
867
|
+
- As a user, I want a responsive design so I can use the app on any device
|
|
868
|
+
- As a user, I want intuitive navigation so I can easily find features
|
|
869
|
+
|
|
870
|
+
## Technical Requirements
|
|
871
|
+
### Frontend
|
|
872
|
+
- Framework: React/Vue/Angular or vanilla JavaScript
|
|
873
|
+
- Styling: CSS framework (Tailwind, Bootstrap, etc.)
|
|
874
|
+
- State Management: Redux/Vuex/Context API
|
|
875
|
+
- Build Tools: Webpack/Vite
|
|
876
|
+
- Testing: Jest/Vitest for unit tests
|
|
877
|
+
|
|
878
|
+
### Backend
|
|
879
|
+
- Runtime: Node.js/Python/Java
|
|
880
|
+
- Database: PostgreSQL/MySQL/MongoDB
|
|
881
|
+
- API: RESTful API or GraphQL
|
|
882
|
+
- Authentication: JWT tokens
|
|
883
|
+
- Testing: Integration and unit tests
|
|
884
|
+
|
|
885
|
+
### Infrastructure
|
|
886
|
+
- Hosting: Cloud provider (AWS, Azure, GCP)
|
|
887
|
+
- CI/CD: GitHub Actions/GitLab CI
|
|
888
|
+
- Monitoring: Application monitoring tools
|
|
889
|
+
- Security: HTTPS, input validation, rate limiting
|
|
890
|
+
|
|
891
|
+
## Success Metrics
|
|
892
|
+
- User engagement metrics
|
|
893
|
+
- Performance benchmarks (load time < 2s)
|
|
894
|
+
- Error rates < 1%
|
|
895
|
+
- User satisfaction scores
|
|
896
|
+
|
|
897
|
+
## Timeline
|
|
898
|
+
- Phase 1: Core functionality (4-6 weeks)
|
|
899
|
+
- Phase 2: Advanced features (2-4 weeks)
|
|
900
|
+
- Phase 3: Polish and launch (2 weeks)
|
|
901
|
+
|
|
902
|
+
## Constraints & Assumptions
|
|
903
|
+
- Budget constraints
|
|
904
|
+
- Technical limitations
|
|
905
|
+
- Team size and expertise
|
|
907
906
|
- Timeline constraints`
|
|
908
907
|
},
|
|
909
908
|
{
|
|
@@ -911,102 +910,102 @@ Brief description of what this web application will do and why it's needed.
|
|
|
911
910
|
name: 'REST API',
|
|
912
911
|
description: 'Template for REST API development projects',
|
|
913
912
|
category: 'backend',
|
|
914
|
-
content: `# Product Requirements Document - REST API
|
|
915
|
-
|
|
916
|
-
## Overview
|
|
917
|
-
**API Name:** [Your API Name]
|
|
918
|
-
**Version:** v1.0
|
|
919
|
-
**Date:** ${new Date().toISOString().split('T')[0]}
|
|
920
|
-
**Author:** [Your Name]
|
|
921
|
-
|
|
922
|
-
## Executive Summary
|
|
923
|
-
Description of the API's purpose, target users, and primary use cases.
|
|
924
|
-
|
|
925
|
-
## API Goals
|
|
926
|
-
- Goal 1: Provide secure data access
|
|
927
|
-
- Goal 2: Ensure scalable architecture
|
|
928
|
-
- Goal 3: Maintain high availability (99.9% uptime)
|
|
929
|
-
|
|
930
|
-
## Functional Requirements
|
|
931
|
-
### Core Endpoints
|
|
932
|
-
1. **Authentication Endpoints**
|
|
933
|
-
- POST /api/auth/login - User authentication
|
|
934
|
-
- POST /api/auth/logout - User logout
|
|
935
|
-
- POST /api/auth/refresh - Token refresh
|
|
936
|
-
- POST /api/auth/register - User registration
|
|
937
|
-
|
|
938
|
-
2. **Data Management Endpoints**
|
|
939
|
-
- GET /api/resources - List resources with pagination
|
|
940
|
-
- GET /api/resources/{id} - Get specific resource
|
|
941
|
-
- POST /api/resources - Create new resource
|
|
942
|
-
- PUT /api/resources/{id} - Update existing resource
|
|
943
|
-
- DELETE /api/resources/{id} - Delete resource
|
|
944
|
-
|
|
945
|
-
3. **Administrative Endpoints**
|
|
946
|
-
- GET /api/admin/users - Manage users (admin only)
|
|
947
|
-
- GET /api/admin/analytics - System analytics
|
|
948
|
-
- POST /api/admin/backup - Trigger system backup
|
|
949
|
-
|
|
950
|
-
## Technical Requirements
|
|
951
|
-
### API Design
|
|
952
|
-
- RESTful architecture following OpenAPI 3.0 specification
|
|
953
|
-
- JSON request/response format
|
|
954
|
-
- Consistent error response format
|
|
955
|
-
- API versioning strategy
|
|
956
|
-
|
|
957
|
-
### Authentication & Security
|
|
958
|
-
- JWT token-based authentication
|
|
959
|
-
- Role-based access control (RBAC)
|
|
960
|
-
- Rate limiting (100 requests/minute per user)
|
|
961
|
-
- Input validation and sanitization
|
|
962
|
-
- HTTPS enforcement
|
|
963
|
-
|
|
964
|
-
### Database
|
|
965
|
-
- Database type: [PostgreSQL/MongoDB/MySQL]
|
|
966
|
-
- Connection pooling
|
|
967
|
-
- Database migrations
|
|
968
|
-
- Backup and recovery procedures
|
|
969
|
-
|
|
970
|
-
### Performance Requirements
|
|
971
|
-
- Response time: < 200ms for 95% of requests
|
|
972
|
-
- Throughput: 1000+ requests/second
|
|
973
|
-
- Concurrent users: 10,000+
|
|
974
|
-
- Database query optimization
|
|
975
|
-
|
|
976
|
-
### Documentation
|
|
977
|
-
- Auto-generated API documentation (Swagger/OpenAPI)
|
|
978
|
-
- Code examples for common use cases
|
|
979
|
-
- SDK development for major languages
|
|
980
|
-
- Postman collection for testing
|
|
981
|
-
|
|
982
|
-
## Error Handling
|
|
983
|
-
- Standardized error codes and messages
|
|
984
|
-
- Proper HTTP status codes
|
|
985
|
-
- Detailed error logging
|
|
986
|
-
- Graceful degradation strategies
|
|
987
|
-
|
|
988
|
-
## Testing Strategy
|
|
989
|
-
- Unit tests (80%+ coverage)
|
|
990
|
-
- Integration tests for all endpoints
|
|
991
|
-
- Load testing and performance testing
|
|
992
|
-
- Security testing (OWASP compliance)
|
|
993
|
-
|
|
994
|
-
## Monitoring & Logging
|
|
995
|
-
- Application performance monitoring
|
|
996
|
-
- Error tracking and alerting
|
|
997
|
-
- Access logs and audit trails
|
|
998
|
-
- Health check endpoints
|
|
999
|
-
|
|
1000
|
-
## Deployment
|
|
1001
|
-
- Containerized deployment (Docker)
|
|
1002
|
-
- CI/CD pipeline setup
|
|
1003
|
-
- Environment management (dev, staging, prod)
|
|
1004
|
-
- Blue-green deployment strategy
|
|
1005
|
-
|
|
1006
|
-
## Success Metrics
|
|
1007
|
-
- API uptime > 99.9%
|
|
1008
|
-
- Average response time < 200ms
|
|
1009
|
-
- Zero critical security vulnerabilities
|
|
913
|
+
content: `# Product Requirements Document - REST API
|
|
914
|
+
|
|
915
|
+
## Overview
|
|
916
|
+
**API Name:** [Your API Name]
|
|
917
|
+
**Version:** v1.0
|
|
918
|
+
**Date:** ${new Date().toISOString().split('T')[0]}
|
|
919
|
+
**Author:** [Your Name]
|
|
920
|
+
|
|
921
|
+
## Executive Summary
|
|
922
|
+
Description of the API's purpose, target users, and primary use cases.
|
|
923
|
+
|
|
924
|
+
## API Goals
|
|
925
|
+
- Goal 1: Provide secure data access
|
|
926
|
+
- Goal 2: Ensure scalable architecture
|
|
927
|
+
- Goal 3: Maintain high availability (99.9% uptime)
|
|
928
|
+
|
|
929
|
+
## Functional Requirements
|
|
930
|
+
### Core Endpoints
|
|
931
|
+
1. **Authentication Endpoints**
|
|
932
|
+
- POST /api/auth/login - User authentication
|
|
933
|
+
- POST /api/auth/logout - User logout
|
|
934
|
+
- POST /api/auth/refresh - Token refresh
|
|
935
|
+
- POST /api/auth/register - User registration
|
|
936
|
+
|
|
937
|
+
2. **Data Management Endpoints**
|
|
938
|
+
- GET /api/resources - List resources with pagination
|
|
939
|
+
- GET /api/resources/{id} - Get specific resource
|
|
940
|
+
- POST /api/resources - Create new resource
|
|
941
|
+
- PUT /api/resources/{id} - Update existing resource
|
|
942
|
+
- DELETE /api/resources/{id} - Delete resource
|
|
943
|
+
|
|
944
|
+
3. **Administrative Endpoints**
|
|
945
|
+
- GET /api/admin/users - Manage users (admin only)
|
|
946
|
+
- GET /api/admin/analytics - System analytics
|
|
947
|
+
- POST /api/admin/backup - Trigger system backup
|
|
948
|
+
|
|
949
|
+
## Technical Requirements
|
|
950
|
+
### API Design
|
|
951
|
+
- RESTful architecture following OpenAPI 3.0 specification
|
|
952
|
+
- JSON request/response format
|
|
953
|
+
- Consistent error response format
|
|
954
|
+
- API versioning strategy
|
|
955
|
+
|
|
956
|
+
### Authentication & Security
|
|
957
|
+
- JWT token-based authentication
|
|
958
|
+
- Role-based access control (RBAC)
|
|
959
|
+
- Rate limiting (100 requests/minute per user)
|
|
960
|
+
- Input validation and sanitization
|
|
961
|
+
- HTTPS enforcement
|
|
962
|
+
|
|
963
|
+
### Database
|
|
964
|
+
- Database type: [PostgreSQL/MongoDB/MySQL]
|
|
965
|
+
- Connection pooling
|
|
966
|
+
- Database migrations
|
|
967
|
+
- Backup and recovery procedures
|
|
968
|
+
|
|
969
|
+
### Performance Requirements
|
|
970
|
+
- Response time: < 200ms for 95% of requests
|
|
971
|
+
- Throughput: 1000+ requests/second
|
|
972
|
+
- Concurrent users: 10,000+
|
|
973
|
+
- Database query optimization
|
|
974
|
+
|
|
975
|
+
### Documentation
|
|
976
|
+
- Auto-generated API documentation (Swagger/OpenAPI)
|
|
977
|
+
- Code examples for common use cases
|
|
978
|
+
- SDK development for major languages
|
|
979
|
+
- Postman collection for testing
|
|
980
|
+
|
|
981
|
+
## Error Handling
|
|
982
|
+
- Standardized error codes and messages
|
|
983
|
+
- Proper HTTP status codes
|
|
984
|
+
- Detailed error logging
|
|
985
|
+
- Graceful degradation strategies
|
|
986
|
+
|
|
987
|
+
## Testing Strategy
|
|
988
|
+
- Unit tests (80%+ coverage)
|
|
989
|
+
- Integration tests for all endpoints
|
|
990
|
+
- Load testing and performance testing
|
|
991
|
+
- Security testing (OWASP compliance)
|
|
992
|
+
|
|
993
|
+
## Monitoring & Logging
|
|
994
|
+
- Application performance monitoring
|
|
995
|
+
- Error tracking and alerting
|
|
996
|
+
- Access logs and audit trails
|
|
997
|
+
- Health check endpoints
|
|
998
|
+
|
|
999
|
+
## Deployment
|
|
1000
|
+
- Containerized deployment (Docker)
|
|
1001
|
+
- CI/CD pipeline setup
|
|
1002
|
+
- Environment management (dev, staging, prod)
|
|
1003
|
+
- Blue-green deployment strategy
|
|
1004
|
+
|
|
1005
|
+
## Success Metrics
|
|
1006
|
+
- API uptime > 99.9%
|
|
1007
|
+
- Average response time < 200ms
|
|
1008
|
+
- Zero critical security vulnerabilities
|
|
1010
1009
|
- Developer adoption metrics`
|
|
1011
1010
|
},
|
|
1012
1011
|
{
|
|
@@ -1014,115 +1013,115 @@ Description of the API's purpose, target users, and primary use cases.
|
|
|
1014
1013
|
name: 'Mobile Application',
|
|
1015
1014
|
description: 'Template for mobile app development projects (iOS/Android)',
|
|
1016
1015
|
category: 'mobile',
|
|
1017
|
-
content: `# Product Requirements Document - Mobile Application
|
|
1018
|
-
|
|
1019
|
-
## Overview
|
|
1020
|
-
**App Name:** [Your App Name]
|
|
1021
|
-
**Platform:** iOS / Android / Cross-platform
|
|
1022
|
-
**Version:** 1.0
|
|
1023
|
-
**Date:** ${new Date().toISOString().split('T')[0]}
|
|
1024
|
-
**Author:** [Your Name]
|
|
1025
|
-
|
|
1026
|
-
## Executive Summary
|
|
1027
|
-
Brief description of the mobile app's purpose, target audience, and key value proposition.
|
|
1028
|
-
|
|
1029
|
-
## Product Goals
|
|
1030
|
-
- Goal 1: [Specific user engagement goal]
|
|
1031
|
-
- Goal 2: [Specific functionality goal]
|
|
1032
|
-
- Goal 3: [Specific performance goal]
|
|
1033
|
-
|
|
1034
|
-
## User Stories
|
|
1035
|
-
### Core Features
|
|
1036
|
-
1. **Onboarding & Authentication**
|
|
1037
|
-
- As a new user, I want a simple onboarding process
|
|
1038
|
-
- As a user, I want to sign up with email or social media
|
|
1039
|
-
- As a user, I want biometric authentication for security
|
|
1040
|
-
|
|
1041
|
-
2. **Main App Features**
|
|
1042
|
-
- As a user, I want [core feature 1] accessible from home screen
|
|
1043
|
-
- As a user, I want [core feature 2] to work offline
|
|
1044
|
-
- As a user, I want to sync data across devices
|
|
1045
|
-
|
|
1046
|
-
3. **User Experience**
|
|
1047
|
-
- As a user, I want intuitive navigation patterns
|
|
1048
|
-
- As a user, I want fast loading times
|
|
1049
|
-
- As a user, I want accessibility features
|
|
1050
|
-
|
|
1051
|
-
## Technical Requirements
|
|
1052
|
-
### Mobile Development
|
|
1053
|
-
- **Cross-platform:** React Native / Flutter / Xamarin
|
|
1054
|
-
- **Native:** Swift (iOS) / Kotlin (Android)
|
|
1055
|
-
- **State Management:** Redux / MobX / Provider
|
|
1056
|
-
- **Navigation:** React Navigation / Flutter Navigation
|
|
1057
|
-
|
|
1058
|
-
### Backend Integration
|
|
1059
|
-
- REST API or GraphQL integration
|
|
1060
|
-
- Real-time features (WebSockets/Push notifications)
|
|
1061
|
-
- Offline data synchronization
|
|
1062
|
-
- Background processing
|
|
1063
|
-
|
|
1064
|
-
### Device Features
|
|
1065
|
-
- Camera and photo library access
|
|
1066
|
-
- GPS location services
|
|
1067
|
-
- Push notifications
|
|
1068
|
-
- Biometric authentication
|
|
1069
|
-
- Device storage
|
|
1070
|
-
|
|
1071
|
-
### Performance Requirements
|
|
1072
|
-
- App launch time < 3 seconds
|
|
1073
|
-
- Screen transition animations < 300ms
|
|
1074
|
-
- Memory usage optimization
|
|
1075
|
-
- Battery usage optimization
|
|
1076
|
-
|
|
1077
|
-
## Platform-Specific Considerations
|
|
1078
|
-
### iOS Requirements
|
|
1079
|
-
- iOS 13.0+ minimum version
|
|
1080
|
-
- App Store guidelines compliance
|
|
1081
|
-
- iOS design guidelines (Human Interface Guidelines)
|
|
1082
|
-
- TestFlight beta testing
|
|
1083
|
-
|
|
1084
|
-
### Android Requirements
|
|
1085
|
-
- Android 8.0+ (API level 26) minimum
|
|
1086
|
-
- Google Play Store guidelines
|
|
1087
|
-
- Material Design guidelines
|
|
1088
|
-
- Google Play Console testing
|
|
1089
|
-
|
|
1090
|
-
## User Interface Design
|
|
1091
|
-
- Responsive design for different screen sizes
|
|
1092
|
-
- Dark mode support
|
|
1093
|
-
- Accessibility compliance (WCAG 2.1)
|
|
1094
|
-
- Consistent design system
|
|
1095
|
-
|
|
1096
|
-
## Security & Privacy
|
|
1097
|
-
- Secure data storage (Keychain/Keystore)
|
|
1098
|
-
- API communication encryption
|
|
1099
|
-
- Privacy policy compliance (GDPR/CCPA)
|
|
1100
|
-
- App security best practices
|
|
1101
|
-
|
|
1102
|
-
## Testing Strategy
|
|
1103
|
-
- Unit testing (80%+ coverage)
|
|
1104
|
-
- UI/E2E testing (Detox/Appium)
|
|
1105
|
-
- Device testing on multiple screen sizes
|
|
1106
|
-
- Performance testing
|
|
1107
|
-
- Security testing
|
|
1108
|
-
|
|
1109
|
-
## App Store Deployment
|
|
1110
|
-
- App store optimization (ASO)
|
|
1111
|
-
- App icons and screenshots
|
|
1112
|
-
- Store listing content
|
|
1113
|
-
- Release management strategy
|
|
1114
|
-
|
|
1115
|
-
## Analytics & Monitoring
|
|
1116
|
-
- User analytics (Firebase/Analytics)
|
|
1117
|
-
- Crash reporting (Crashlytics/Sentry)
|
|
1118
|
-
- Performance monitoring
|
|
1119
|
-
- User feedback collection
|
|
1120
|
-
|
|
1121
|
-
## Success Metrics
|
|
1122
|
-
- App store ratings > 4.0
|
|
1123
|
-
- User retention rates
|
|
1124
|
-
- Daily/Monthly active users
|
|
1125
|
-
- App performance metrics
|
|
1016
|
+
content: `# Product Requirements Document - Mobile Application
|
|
1017
|
+
|
|
1018
|
+
## Overview
|
|
1019
|
+
**App Name:** [Your App Name]
|
|
1020
|
+
**Platform:** iOS / Android / Cross-platform
|
|
1021
|
+
**Version:** 1.0
|
|
1022
|
+
**Date:** ${new Date().toISOString().split('T')[0]}
|
|
1023
|
+
**Author:** [Your Name]
|
|
1024
|
+
|
|
1025
|
+
## Executive Summary
|
|
1026
|
+
Brief description of the mobile app's purpose, target audience, and key value proposition.
|
|
1027
|
+
|
|
1028
|
+
## Product Goals
|
|
1029
|
+
- Goal 1: [Specific user engagement goal]
|
|
1030
|
+
- Goal 2: [Specific functionality goal]
|
|
1031
|
+
- Goal 3: [Specific performance goal]
|
|
1032
|
+
|
|
1033
|
+
## User Stories
|
|
1034
|
+
### Core Features
|
|
1035
|
+
1. **Onboarding & Authentication**
|
|
1036
|
+
- As a new user, I want a simple onboarding process
|
|
1037
|
+
- As a user, I want to sign up with email or social media
|
|
1038
|
+
- As a user, I want biometric authentication for security
|
|
1039
|
+
|
|
1040
|
+
2. **Main App Features**
|
|
1041
|
+
- As a user, I want [core feature 1] accessible from home screen
|
|
1042
|
+
- As a user, I want [core feature 2] to work offline
|
|
1043
|
+
- As a user, I want to sync data across devices
|
|
1044
|
+
|
|
1045
|
+
3. **User Experience**
|
|
1046
|
+
- As a user, I want intuitive navigation patterns
|
|
1047
|
+
- As a user, I want fast loading times
|
|
1048
|
+
- As a user, I want accessibility features
|
|
1049
|
+
|
|
1050
|
+
## Technical Requirements
|
|
1051
|
+
### Mobile Development
|
|
1052
|
+
- **Cross-platform:** React Native / Flutter / Xamarin
|
|
1053
|
+
- **Native:** Swift (iOS) / Kotlin (Android)
|
|
1054
|
+
- **State Management:** Redux / MobX / Provider
|
|
1055
|
+
- **Navigation:** React Navigation / Flutter Navigation
|
|
1056
|
+
|
|
1057
|
+
### Backend Integration
|
|
1058
|
+
- REST API or GraphQL integration
|
|
1059
|
+
- Real-time features (WebSockets/Push notifications)
|
|
1060
|
+
- Offline data synchronization
|
|
1061
|
+
- Background processing
|
|
1062
|
+
|
|
1063
|
+
### Device Features
|
|
1064
|
+
- Camera and photo library access
|
|
1065
|
+
- GPS location services
|
|
1066
|
+
- Push notifications
|
|
1067
|
+
- Biometric authentication
|
|
1068
|
+
- Device storage
|
|
1069
|
+
|
|
1070
|
+
### Performance Requirements
|
|
1071
|
+
- App launch time < 3 seconds
|
|
1072
|
+
- Screen transition animations < 300ms
|
|
1073
|
+
- Memory usage optimization
|
|
1074
|
+
- Battery usage optimization
|
|
1075
|
+
|
|
1076
|
+
## Platform-Specific Considerations
|
|
1077
|
+
### iOS Requirements
|
|
1078
|
+
- iOS 13.0+ minimum version
|
|
1079
|
+
- App Store guidelines compliance
|
|
1080
|
+
- iOS design guidelines (Human Interface Guidelines)
|
|
1081
|
+
- TestFlight beta testing
|
|
1082
|
+
|
|
1083
|
+
### Android Requirements
|
|
1084
|
+
- Android 8.0+ (API level 26) minimum
|
|
1085
|
+
- Google Play Store guidelines
|
|
1086
|
+
- Material Design guidelines
|
|
1087
|
+
- Google Play Console testing
|
|
1088
|
+
|
|
1089
|
+
## User Interface Design
|
|
1090
|
+
- Responsive design for different screen sizes
|
|
1091
|
+
- Dark mode support
|
|
1092
|
+
- Accessibility compliance (WCAG 2.1)
|
|
1093
|
+
- Consistent design system
|
|
1094
|
+
|
|
1095
|
+
## Security & Privacy
|
|
1096
|
+
- Secure data storage (Keychain/Keystore)
|
|
1097
|
+
- API communication encryption
|
|
1098
|
+
- Privacy policy compliance (GDPR/CCPA)
|
|
1099
|
+
- App security best practices
|
|
1100
|
+
|
|
1101
|
+
## Testing Strategy
|
|
1102
|
+
- Unit testing (80%+ coverage)
|
|
1103
|
+
- UI/E2E testing (Detox/Appium)
|
|
1104
|
+
- Device testing on multiple screen sizes
|
|
1105
|
+
- Performance testing
|
|
1106
|
+
- Security testing
|
|
1107
|
+
|
|
1108
|
+
## App Store Deployment
|
|
1109
|
+
- App store optimization (ASO)
|
|
1110
|
+
- App icons and screenshots
|
|
1111
|
+
- Store listing content
|
|
1112
|
+
- Release management strategy
|
|
1113
|
+
|
|
1114
|
+
## Analytics & Monitoring
|
|
1115
|
+
- User analytics (Firebase/Analytics)
|
|
1116
|
+
- Crash reporting (Crashlytics/Sentry)
|
|
1117
|
+
- Performance monitoring
|
|
1118
|
+
- User feedback collection
|
|
1119
|
+
|
|
1120
|
+
## Success Metrics
|
|
1121
|
+
- App store ratings > 4.0
|
|
1122
|
+
- User retention rates
|
|
1123
|
+
- Daily/Monthly active users
|
|
1124
|
+
- App performance metrics
|
|
1126
1125
|
- Conversion rates`
|
|
1127
1126
|
},
|
|
1128
1127
|
{
|
|
@@ -1130,127 +1129,127 @@ Brief description of the mobile app's purpose, target audience, and key value pr
|
|
|
1130
1129
|
name: 'Data Analysis Project',
|
|
1131
1130
|
description: 'Template for data analysis and visualization projects',
|
|
1132
1131
|
category: 'data',
|
|
1133
|
-
content: `# Product Requirements Document - Data Analysis Project
|
|
1134
|
-
|
|
1135
|
-
## Overview
|
|
1136
|
-
**Project Name:** [Your Analysis Project]
|
|
1137
|
-
**Analysis Type:** [Descriptive/Predictive/Prescriptive]
|
|
1138
|
-
**Date:** ${new Date().toISOString().split('T')[0]}
|
|
1139
|
-
**Author:** [Your Name]
|
|
1140
|
-
|
|
1141
|
-
## Executive Summary
|
|
1142
|
-
Description of the business problem, data sources, and expected insights.
|
|
1143
|
-
|
|
1144
|
-
## Project Goals
|
|
1145
|
-
- Goal 1: [Specific business question to answer]
|
|
1146
|
-
- Goal 2: [Specific prediction to make]
|
|
1147
|
-
- Goal 3: [Specific recommendation to provide]
|
|
1148
|
-
|
|
1149
|
-
## Business Requirements
|
|
1150
|
-
### Key Questions
|
|
1151
|
-
1. What patterns exist in the current data?
|
|
1152
|
-
2. What factors influence [target variable]?
|
|
1153
|
-
3. What predictions can be made for [future outcome]?
|
|
1154
|
-
4. What recommendations can improve [business metric]?
|
|
1155
|
-
|
|
1156
|
-
### Success Criteria
|
|
1157
|
-
- Actionable insights for stakeholders
|
|
1158
|
-
- Statistical significance in findings
|
|
1159
|
-
- Reproducible analysis pipeline
|
|
1160
|
-
- Clear visualization and reporting
|
|
1161
|
-
|
|
1162
|
-
## Data Requirements
|
|
1163
|
-
### Data Sources
|
|
1164
|
-
1. **Primary Data**
|
|
1165
|
-
- Source: [Database/API/Files]
|
|
1166
|
-
- Format: [CSV/JSON/SQL]
|
|
1167
|
-
- Size: [Volume estimate]
|
|
1168
|
-
- Update frequency: [Real-time/Daily/Monthly]
|
|
1169
|
-
|
|
1170
|
-
2. **External Data**
|
|
1171
|
-
- Third-party APIs
|
|
1172
|
-
- Public datasets
|
|
1173
|
-
- Market research data
|
|
1174
|
-
|
|
1175
|
-
### Data Quality Requirements
|
|
1176
|
-
- Data completeness (< 5% missing values)
|
|
1177
|
-
- Data accuracy validation
|
|
1178
|
-
- Data consistency checks
|
|
1179
|
-
- Historical data availability
|
|
1180
|
-
|
|
1181
|
-
## Technical Requirements
|
|
1182
|
-
### Data Pipeline
|
|
1183
|
-
- Data extraction and ingestion
|
|
1184
|
-
- Data cleaning and preprocessing
|
|
1185
|
-
- Data transformation and feature engineering
|
|
1186
|
-
- Data validation and quality checks
|
|
1187
|
-
|
|
1188
|
-
### Analysis Tools
|
|
1189
|
-
- **Programming:** Python/R/SQL
|
|
1190
|
-
- **Libraries:** pandas, numpy, scikit-learn, matplotlib
|
|
1191
|
-
- **Visualization:** Tableau, PowerBI, or custom dashboards
|
|
1192
|
-
- **Version Control:** Git for code and DVC for data
|
|
1193
|
-
|
|
1194
|
-
### Computing Resources
|
|
1195
|
-
- Local development environment
|
|
1196
|
-
- Cloud computing (AWS/GCP/Azure) if needed
|
|
1197
|
-
- Database access and permissions
|
|
1198
|
-
- Storage requirements
|
|
1199
|
-
|
|
1200
|
-
## Analysis Methodology
|
|
1201
|
-
### Data Exploration
|
|
1202
|
-
1. Descriptive statistics and data profiling
|
|
1203
|
-
2. Data visualization and pattern identification
|
|
1204
|
-
3. Correlation analysis
|
|
1205
|
-
4. Outlier detection and handling
|
|
1206
|
-
|
|
1207
|
-
### Statistical Analysis
|
|
1208
|
-
1. Hypothesis formulation
|
|
1209
|
-
2. Statistical testing
|
|
1210
|
-
3. Confidence intervals
|
|
1211
|
-
4. Effect size calculations
|
|
1212
|
-
|
|
1213
|
-
### Machine Learning (if applicable)
|
|
1214
|
-
1. Feature selection and engineering
|
|
1215
|
-
2. Model selection and training
|
|
1216
|
-
3. Cross-validation and evaluation
|
|
1217
|
-
4. Model interpretation and explainability
|
|
1218
|
-
|
|
1219
|
-
## Deliverables
|
|
1220
|
-
### Reports
|
|
1221
|
-
- Executive summary for stakeholders
|
|
1222
|
-
- Technical analysis report
|
|
1223
|
-
- Data quality report
|
|
1224
|
-
- Methodology documentation
|
|
1225
|
-
|
|
1226
|
-
### Visualizations
|
|
1227
|
-
- Interactive dashboards
|
|
1228
|
-
- Static charts and graphs
|
|
1229
|
-
- Data story presentations
|
|
1230
|
-
- Key findings infographics
|
|
1231
|
-
|
|
1232
|
-
### Code & Documentation
|
|
1233
|
-
- Reproducible analysis scripts
|
|
1234
|
-
- Data pipeline code
|
|
1235
|
-
- Documentation and comments
|
|
1236
|
-
- Testing and validation code
|
|
1237
|
-
|
|
1238
|
-
## Timeline
|
|
1239
|
-
- Phase 1: Data collection and exploration (2 weeks)
|
|
1240
|
-
- Phase 2: Analysis and modeling (3 weeks)
|
|
1241
|
-
- Phase 3: Reporting and visualization (1 week)
|
|
1242
|
-
- Phase 4: Stakeholder presentation (1 week)
|
|
1243
|
-
|
|
1244
|
-
## Risks & Assumptions
|
|
1245
|
-
- Data availability and quality risks
|
|
1246
|
-
- Technical complexity assumptions
|
|
1247
|
-
- Resource and timeline constraints
|
|
1248
|
-
- Stakeholder engagement assumptions
|
|
1249
|
-
|
|
1250
|
-
## Success Metrics
|
|
1251
|
-
- Stakeholder satisfaction with insights
|
|
1252
|
-
- Accuracy of predictions (if applicable)
|
|
1253
|
-
- Business impact of recommendations
|
|
1132
|
+
content: `# Product Requirements Document - Data Analysis Project
|
|
1133
|
+
|
|
1134
|
+
## Overview
|
|
1135
|
+
**Project Name:** [Your Analysis Project]
|
|
1136
|
+
**Analysis Type:** [Descriptive/Predictive/Prescriptive]
|
|
1137
|
+
**Date:** ${new Date().toISOString().split('T')[0]}
|
|
1138
|
+
**Author:** [Your Name]
|
|
1139
|
+
|
|
1140
|
+
## Executive Summary
|
|
1141
|
+
Description of the business problem, data sources, and expected insights.
|
|
1142
|
+
|
|
1143
|
+
## Project Goals
|
|
1144
|
+
- Goal 1: [Specific business question to answer]
|
|
1145
|
+
- Goal 2: [Specific prediction to make]
|
|
1146
|
+
- Goal 3: [Specific recommendation to provide]
|
|
1147
|
+
|
|
1148
|
+
## Business Requirements
|
|
1149
|
+
### Key Questions
|
|
1150
|
+
1. What patterns exist in the current data?
|
|
1151
|
+
2. What factors influence [target variable]?
|
|
1152
|
+
3. What predictions can be made for [future outcome]?
|
|
1153
|
+
4. What recommendations can improve [business metric]?
|
|
1154
|
+
|
|
1155
|
+
### Success Criteria
|
|
1156
|
+
- Actionable insights for stakeholders
|
|
1157
|
+
- Statistical significance in findings
|
|
1158
|
+
- Reproducible analysis pipeline
|
|
1159
|
+
- Clear visualization and reporting
|
|
1160
|
+
|
|
1161
|
+
## Data Requirements
|
|
1162
|
+
### Data Sources
|
|
1163
|
+
1. **Primary Data**
|
|
1164
|
+
- Source: [Database/API/Files]
|
|
1165
|
+
- Format: [CSV/JSON/SQL]
|
|
1166
|
+
- Size: [Volume estimate]
|
|
1167
|
+
- Update frequency: [Real-time/Daily/Monthly]
|
|
1168
|
+
|
|
1169
|
+
2. **External Data**
|
|
1170
|
+
- Third-party APIs
|
|
1171
|
+
- Public datasets
|
|
1172
|
+
- Market research data
|
|
1173
|
+
|
|
1174
|
+
### Data Quality Requirements
|
|
1175
|
+
- Data completeness (< 5% missing values)
|
|
1176
|
+
- Data accuracy validation
|
|
1177
|
+
- Data consistency checks
|
|
1178
|
+
- Historical data availability
|
|
1179
|
+
|
|
1180
|
+
## Technical Requirements
|
|
1181
|
+
### Data Pipeline
|
|
1182
|
+
- Data extraction and ingestion
|
|
1183
|
+
- Data cleaning and preprocessing
|
|
1184
|
+
- Data transformation and feature engineering
|
|
1185
|
+
- Data validation and quality checks
|
|
1186
|
+
|
|
1187
|
+
### Analysis Tools
|
|
1188
|
+
- **Programming:** Python/R/SQL
|
|
1189
|
+
- **Libraries:** pandas, numpy, scikit-learn, matplotlib
|
|
1190
|
+
- **Visualization:** Tableau, PowerBI, or custom dashboards
|
|
1191
|
+
- **Version Control:** Git for code and DVC for data
|
|
1192
|
+
|
|
1193
|
+
### Computing Resources
|
|
1194
|
+
- Local development environment
|
|
1195
|
+
- Cloud computing (AWS/GCP/Azure) if needed
|
|
1196
|
+
- Database access and permissions
|
|
1197
|
+
- Storage requirements
|
|
1198
|
+
|
|
1199
|
+
## Analysis Methodology
|
|
1200
|
+
### Data Exploration
|
|
1201
|
+
1. Descriptive statistics and data profiling
|
|
1202
|
+
2. Data visualization and pattern identification
|
|
1203
|
+
3. Correlation analysis
|
|
1204
|
+
4. Outlier detection and handling
|
|
1205
|
+
|
|
1206
|
+
### Statistical Analysis
|
|
1207
|
+
1. Hypothesis formulation
|
|
1208
|
+
2. Statistical testing
|
|
1209
|
+
3. Confidence intervals
|
|
1210
|
+
4. Effect size calculations
|
|
1211
|
+
|
|
1212
|
+
### Machine Learning (if applicable)
|
|
1213
|
+
1. Feature selection and engineering
|
|
1214
|
+
2. Model selection and training
|
|
1215
|
+
3. Cross-validation and evaluation
|
|
1216
|
+
4. Model interpretation and explainability
|
|
1217
|
+
|
|
1218
|
+
## Deliverables
|
|
1219
|
+
### Reports
|
|
1220
|
+
- Executive summary for stakeholders
|
|
1221
|
+
- Technical analysis report
|
|
1222
|
+
- Data quality report
|
|
1223
|
+
- Methodology documentation
|
|
1224
|
+
|
|
1225
|
+
### Visualizations
|
|
1226
|
+
- Interactive dashboards
|
|
1227
|
+
- Static charts and graphs
|
|
1228
|
+
- Data story presentations
|
|
1229
|
+
- Key findings infographics
|
|
1230
|
+
|
|
1231
|
+
### Code & Documentation
|
|
1232
|
+
- Reproducible analysis scripts
|
|
1233
|
+
- Data pipeline code
|
|
1234
|
+
- Documentation and comments
|
|
1235
|
+
- Testing and validation code
|
|
1236
|
+
|
|
1237
|
+
## Timeline
|
|
1238
|
+
- Phase 1: Data collection and exploration (2 weeks)
|
|
1239
|
+
- Phase 2: Analysis and modeling (3 weeks)
|
|
1240
|
+
- Phase 3: Reporting and visualization (1 week)
|
|
1241
|
+
- Phase 4: Stakeholder presentation (1 week)
|
|
1242
|
+
|
|
1243
|
+
## Risks & Assumptions
|
|
1244
|
+
- Data availability and quality risks
|
|
1245
|
+
- Technical complexity assumptions
|
|
1246
|
+
- Resource and timeline constraints
|
|
1247
|
+
- Stakeholder engagement assumptions
|
|
1248
|
+
|
|
1249
|
+
## Success Metrics
|
|
1250
|
+
- Stakeholder satisfaction with insights
|
|
1251
|
+
- Accuracy of predictions (if applicable)
|
|
1252
|
+
- Business impact of recommendations
|
|
1254
1253
|
- Reproducibility of results`
|
|
1255
1254
|
}
|
|
1256
1255
|
];
|
|
@@ -1356,31 +1355,31 @@ async function getAvailableTemplates() {
|
|
|
1356
1355
|
name: 'Web Application',
|
|
1357
1356
|
description: 'Template for web application projects',
|
|
1358
1357
|
category: 'web',
|
|
1359
|
-
content: `# Product Requirements Document - Web Application
|
|
1360
|
-
|
|
1361
|
-
## Overview
|
|
1362
|
-
**Product Name:** [Your App Name]
|
|
1363
|
-
**Version:** 1.0
|
|
1364
|
-
**Date:** ${new Date().toISOString().split('T')[0]}
|
|
1365
|
-
**Author:** [Your Name]
|
|
1366
|
-
|
|
1367
|
-
## Executive Summary
|
|
1368
|
-
Brief description of what this web application will do and why it's needed.
|
|
1369
|
-
|
|
1370
|
-
## User Stories
|
|
1371
|
-
1. As a user, I want [feature] so I can [benefit]
|
|
1372
|
-
2. As a user, I want [feature] so I can [benefit]
|
|
1373
|
-
3. As a user, I want [feature] so I can [benefit]
|
|
1374
|
-
|
|
1375
|
-
## Technical Requirements
|
|
1376
|
-
- Frontend framework
|
|
1377
|
-
- Backend services
|
|
1378
|
-
- Database requirements
|
|
1379
|
-
- Security considerations
|
|
1380
|
-
|
|
1381
|
-
## Success Metrics
|
|
1382
|
-
- User engagement metrics
|
|
1383
|
-
- Performance benchmarks
|
|
1358
|
+
content: `# Product Requirements Document - Web Application
|
|
1359
|
+
|
|
1360
|
+
## Overview
|
|
1361
|
+
**Product Name:** [Your App Name]
|
|
1362
|
+
**Version:** 1.0
|
|
1363
|
+
**Date:** ${new Date().toISOString().split('T')[0]}
|
|
1364
|
+
**Author:** [Your Name]
|
|
1365
|
+
|
|
1366
|
+
## Executive Summary
|
|
1367
|
+
Brief description of what this web application will do and why it's needed.
|
|
1368
|
+
|
|
1369
|
+
## User Stories
|
|
1370
|
+
1. As a user, I want [feature] so I can [benefit]
|
|
1371
|
+
2. As a user, I want [feature] so I can [benefit]
|
|
1372
|
+
3. As a user, I want [feature] so I can [benefit]
|
|
1373
|
+
|
|
1374
|
+
## Technical Requirements
|
|
1375
|
+
- Frontend framework
|
|
1376
|
+
- Backend services
|
|
1377
|
+
- Database requirements
|
|
1378
|
+
- Security considerations
|
|
1379
|
+
|
|
1380
|
+
## Success Metrics
|
|
1381
|
+
- User engagement metrics
|
|
1382
|
+
- Performance benchmarks
|
|
1384
1383
|
- Business objectives`
|
|
1385
1384
|
},
|
|
1386
1385
|
// Add other templates here if needed
|