ai-flow-dev 1.0.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.
- package/LICENSE +21 -0
- package/README.md +408 -0
- package/dist/cli.d.ts +3 -0
- package/dist/cli.d.ts.map +1 -0
- package/dist/cli.js +791 -0
- package/dist/cli.js.map +1 -0
- package/dist/fs-utils.d.ts +2 -0
- package/dist/fs-utils.d.ts.map +1 -0
- package/dist/fs-utils.js +46 -0
- package/dist/fs-utils.js.map +1 -0
- package/package.json +71 -0
- package/prompts/backend/flow-dev-feature.md +1318 -0
- package/prompts/backend/flow-dev-fix.md +903 -0
- package/prompts/backend/flow-dev-refactor.md +715 -0
- package/prompts/backend/flow-dev-review.md +401 -0
- package/prompts/backend/flow-dev-work.md +1129 -0
- package/prompts/backend/flow-docs-gen-phase-0.md +1840 -0
- package/prompts/backend/flow-docs-gen-phase-1.md +435 -0
- package/prompts/backend/flow-docs-gen-phase-2.md +460 -0
- package/prompts/backend/flow-docs-gen-phase-3.md +684 -0
- package/prompts/backend/flow-docs-gen-phase-4.md +516 -0
- package/prompts/backend/flow-docs-gen-phase-5.md +637 -0
- package/prompts/backend/flow-docs-gen-phase-6.md +465 -0
- package/prompts/backend/flow-docs-gen-phase-7.md +1207 -0
- package/prompts/backend/flow-docs-gen.md +820 -0
- package/prompts/backend/flow-docs-sync.md +526 -0
- package/prompts/backend/flow-project-init.md +248 -0
- package/prompts/backend/flow-project-roadmap.md +1159 -0
- package/prompts/frontend/flow-docs-gen-phase-0.md +494 -0
- package/prompts/frontend/flow-docs-gen-phase-1.md +449 -0
- package/prompts/frontend/flow-docs-gen-phase-2.md +983 -0
- package/prompts/frontend/flow-docs-gen-phase-3.md +685 -0
- package/prompts/frontend/flow-docs-gen-phase-4.md +480 -0
- package/prompts/frontend/flow-docs-gen-phase-5.md +483 -0
- package/prompts/frontend/flow-docs-gen-phase-6.md +570 -0
- package/prompts/frontend/flow-docs-gen-phase-7.md +582 -0
- package/prompts/frontend/flow-docs-gen.md +413 -0
- package/prompts/frontend/flow-docs-sync.md +561 -0
- package/prompts/mobile/flow-docs-gen-phase-0.md +387 -0
- package/prompts/mobile/flow-docs-gen-phase-1.md +530 -0
- package/prompts/mobile/flow-docs-gen-phase-2.md +584 -0
- package/prompts/mobile/flow-docs-gen-phase-3.md +659 -0
- package/prompts/mobile/flow-docs-gen-phase-4.md +363 -0
- package/prompts/mobile/flow-docs-gen-phase-5.md +369 -0
- package/prompts/mobile/flow-docs-gen-phase-6.md +490 -0
- package/prompts/mobile/flow-docs-gen-phase-7.md +407 -0
- package/prompts/mobile/flow-docs-gen.md +430 -0
- package/prompts/mobile/flow-docs-sync.md +634 -0
- package/templates/backend/.clauderules.template +111 -0
- package/templates/backend/.cursorrules.template +102 -0
- package/templates/backend/.env.example.template +122 -0
- package/templates/backend/README.template.md +200 -0
- package/templates/backend/ai-instructions.template.md +354 -0
- package/templates/backend/copilot-instructions.template.md +160 -0
- package/templates/backend/docs/api.template.md +251 -0
- package/templates/backend/docs/architecture.template.md +612 -0
- package/templates/backend/docs/business-flows.template.md +109 -0
- package/templates/backend/docs/code-standards.template.md +828 -0
- package/templates/backend/docs/contributing.template.md +163 -0
- package/templates/backend/docs/data-model.template.md +416 -0
- package/templates/backend/docs/operations.template.md +591 -0
- package/templates/backend/docs/testing.template.md +762 -0
- package/templates/backend/project-brief.template.md +176 -0
- package/templates/backend/specs/configuration.template.md +133 -0
- package/templates/backend/specs/security.template.md +422 -0
- package/templates/frontend/README.template.md +121 -0
- package/templates/frontend/ai-instructions.template.md +368 -0
- package/templates/frontend/docs/api-integration.template.md +390 -0
- package/templates/frontend/docs/components.template.md +567 -0
- package/templates/frontend/docs/error-handling.template.md +385 -0
- package/templates/frontend/docs/operations.template.md +123 -0
- package/templates/frontend/docs/performance.template.md +140 -0
- package/templates/frontend/docs/pwa.template.md +135 -0
- package/templates/frontend/docs/state-management.template.md +394 -0
- package/templates/frontend/docs/styling.template.md +779 -0
- package/templates/frontend/docs/testing.template.md +736 -0
- package/templates/frontend/project-brief.template.md +55 -0
- package/templates/frontend/specs/accessibility.template.md +111 -0
- package/templates/frontend/specs/configuration.template.md +520 -0
- package/templates/frontend/specs/security.template.md +197 -0
- package/templates/fullstack/README.template.md +282 -0
- package/templates/fullstack/ai-instructions.template.md +487 -0
- package/templates/fullstack/project-brief.template.md +197 -0
- package/templates/fullstack/specs/configuration.template.md +380 -0
- package/templates/mobile/AGENT.template.md +251 -0
- package/templates/mobile/README.template.md +195 -0
- package/templates/mobile/ai-instructions.template.md +221 -0
- package/templates/mobile/docs/app-store.template.md +163 -0
- package/templates/mobile/docs/architecture.template.md +100 -0
- package/templates/mobile/docs/native-features.template.md +137 -0
- package/templates/mobile/docs/navigation.template.md +81 -0
- package/templates/mobile/docs/offline-strategy.template.md +90 -0
- package/templates/mobile/docs/permissions.template.md +70 -0
- package/templates/mobile/docs/state-management.template.md +116 -0
- package/templates/mobile/docs/testing.template.md +146 -0
- package/templates/mobile/project-brief.template.md +97 -0
- package/templates/mobile/specs/build-configuration.template.md +116 -0
- package/templates/mobile/specs/deployment.template.md +114 -0
- package/templates/shared/AGENT.template.md +252 -0
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
# Claude Code Configuration for {{PROJECT_NAME}}
|
|
2
|
+
|
|
3
|
+
## ๐ Quick Start
|
|
4
|
+
|
|
5
|
+
**IMPORTANT:** Read `AGENT.md` first for complete project context.
|
|
6
|
+
|
|
7
|
+
This file contains Claude Code-specific preferences and workflows.
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## ๐ฏ Project Summary
|
|
12
|
+
|
|
13
|
+
**Name:** {{PROJECT_NAME}}
|
|
14
|
+
|
|
15
|
+
**Description:** {{PROJECT_DESCRIPTION}}
|
|
16
|
+
|
|
17
|
+
**Stack:** {{FRAMEWORK}} + {{LANGUAGE}} + {{DATABASE}}
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## ๐ Documentation Architecture
|
|
22
|
+
|
|
23
|
+
**Always reference these files in order:**
|
|
24
|
+
|
|
25
|
+
1. `AGENT.md` - Universal AI configuration (READ FIRST)
|
|
26
|
+
2. `ai-instructions.md` - Tech stack, rules, workflow
|
|
27
|
+
3. `project-brief.md` - Business context
|
|
28
|
+
4. `README.md` - Developer onboarding & commands
|
|
29
|
+
5. `docs/architecture.md` - System architecture
|
|
30
|
+
6. `docs/data-model.md` - Database design
|
|
31
|
+
7. `docs/code-standards.md` - Code quality standards
|
|
32
|
+
8. `docs/testing.md` - Testing strategy
|
|
33
|
+
9. `docs/operations.md` - Deployment & operational procedures
|
|
34
|
+
10. `docs/business-flows.md` - Business process flows and diagrams
|
|
35
|
+
11. `docs/api.md` - API reference and conventions
|
|
36
|
+
12. `docs/contributing.md` - Contribution workflow
|
|
37
|
+
13. `specs/security.md` - Security policies
|
|
38
|
+
14. `specs/configuration.md` - Environment config
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## โ CRITICAL RULES - NEVER
|
|
43
|
+
|
|
44
|
+
{{NEVER_RULES_SUMMARY}}
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## โ
CRITICAL RULES - ALWAYS
|
|
49
|
+
|
|
50
|
+
{{ALWAYS_RULES_SUMMARY}}
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
## ๐๏ธ Architecture Pattern
|
|
55
|
+
|
|
56
|
+
**Pattern:** {{ARCHITECTURE_PATTERN}}
|
|
57
|
+
|
|
58
|
+
**File Organization:** {{FILE_ORGANIZATION}}
|
|
59
|
+
|
|
60
|
+
---
|
|
61
|
+
|
|
62
|
+
## ๐งช Testing Requirements
|
|
63
|
+
|
|
64
|
+
- Minimum {{MIN_COVERAGE}}% coverage
|
|
65
|
+
- Write tests for all new features
|
|
66
|
+
- Run tests before committing: `{{TEST_COMMAND}}`
|
|
67
|
+
|
|
68
|
+
---
|
|
69
|
+
|
|
70
|
+
## ๐ Commit Format
|
|
71
|
+
|
|
72
|
+
{{COMMIT_FORMAT_EXAMPLE}}
|
|
73
|
+
|
|
74
|
+
---
|
|
75
|
+
|
|
76
|
+
## ๐ Claude Code Workflow
|
|
77
|
+
|
|
78
|
+
### Plan Mode
|
|
79
|
+
1. Always use plan mode for complex features
|
|
80
|
+
2. Break down into small, testable chunks
|
|
81
|
+
3. Get user approval before implementation
|
|
82
|
+
|
|
83
|
+
### Implementation
|
|
84
|
+
1. Follow architecture patterns strictly
|
|
85
|
+
2. Write tests alongside code
|
|
86
|
+
3. Update documentation if behavior changes
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
## ๐ Security Checklist
|
|
91
|
+
|
|
92
|
+
- [ ] Input validation with {{VALIDATION_LIBRARY}}
|
|
93
|
+
- [ ] Authentication/authorization checked
|
|
94
|
+
- [ ] No hardcoded secrets
|
|
95
|
+
- [ ] No sensitive data in logs
|
|
96
|
+
- [ ] Rate limiting for public endpoints
|
|
97
|
+
|
|
98
|
+
---
|
|
99
|
+
|
|
100
|
+
## ๐ก Claude-Specific Tips
|
|
101
|
+
|
|
102
|
+
- Use `/bootstrap` command for starting documentation generation
|
|
103
|
+
- Use plan mode for architectural decisions
|
|
104
|
+
- Reference `AGENT.md` for any clarifications
|
|
105
|
+
- Ask user before making breaking changes
|
|
106
|
+
|
|
107
|
+
---
|
|
108
|
+
|
|
109
|
+
**For full context, always read `AGENT.md` and `ai-instructions.md` before starting work.**
|
|
110
|
+
|
|
111
|
+
**Generated by:** AI Flow v1.0.0
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
# Cursor Configuration for {{PROJECT_NAME}}
|
|
2
|
+
|
|
3
|
+
## ๐ Quick Start
|
|
4
|
+
|
|
5
|
+
**IMPORTANT:** Read `AGENT.md` first for complete project context.
|
|
6
|
+
|
|
7
|
+
This file contains Cursor-specific preferences and workflows.
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## ๐ฏ Project Summary
|
|
12
|
+
|
|
13
|
+
**Name:** {{PROJECT_NAME}}
|
|
14
|
+
**Description:** {{PROJECT_DESCRIPTION}}
|
|
15
|
+
**Stack:** {{FRAMEWORK}} + {{LANGUAGE}} + {{DATABASE}}
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## ๐ Documentation
|
|
20
|
+
|
|
21
|
+
Read these files in order:
|
|
22
|
+
|
|
23
|
+
1. `AGENT.md` - Universal AI configuration (โญ START HERE)
|
|
24
|
+
2. `ai-instructions.md` - Tech stack, rules, workflow
|
|
25
|
+
3. `project-brief.md` - Business context
|
|
26
|
+
4. `README.md` - Developer onboarding & commands
|
|
27
|
+
5. `docs/architecture.md` - System architecture
|
|
28
|
+
6. `docs/data-model.md` - Database design
|
|
29
|
+
7. `docs/code-standards.md` - Code quality standards
|
|
30
|
+
8. `docs/testing.md` - Testing strategy and coverage rules
|
|
31
|
+
9. `docs/operations.md` - Deployment & operational procedures
|
|
32
|
+
10. `docs/business-flows.md` - Business process flows and diagrams
|
|
33
|
+
11. `docs/api.md` - API reference and conventions
|
|
34
|
+
12. `docs/contributing.md` - Contribution workflow
|
|
35
|
+
13. `specs/security.md` - Security policies
|
|
36
|
+
14. `specs/configuration.md` - Environment configuration
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## โ NEVER
|
|
41
|
+
|
|
42
|
+
{{NEVER_RULES_SUMMARY}}
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## โ
ALWAYS
|
|
47
|
+
|
|
48
|
+
{{ALWAYS_RULES_SUMMARY}}
|
|
49
|
+
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
## ๐๏ธ Architecture
|
|
53
|
+
|
|
54
|
+
**Pattern:** {{ARCHITECTURE_PATTERN}}
|
|
55
|
+
**Organization:** {{FILE_ORGANIZATION}}
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
## ๐จ Code Style
|
|
60
|
+
|
|
61
|
+
- Indentation: {{INDENTATION}}
|
|
62
|
+
- Quotes: {{QUOTE_STYLE}}
|
|
63
|
+
- Formatter: {{FORMATTER}}
|
|
64
|
+
- Linter: {{LINTER}}
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
## ๐งช Testing
|
|
69
|
+
|
|
70
|
+
- Coverage: {{MIN_COVERAGE}}%+ required
|
|
71
|
+
- Framework: {{TEST_FRAMEWORK}}
|
|
72
|
+
- Command: `{{TEST_COMMAND}}`
|
|
73
|
+
|
|
74
|
+
---
|
|
75
|
+
|
|
76
|
+
## ๐ Commits
|
|
77
|
+
|
|
78
|
+
{{COMMIT_FORMAT_EXAMPLE}}
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
## ๐ Security
|
|
83
|
+
|
|
84
|
+
- Validate all inputs: {{VALIDATION_LIBRARY}}
|
|
85
|
+
- Auth method: {{AUTH_METHOD}}
|
|
86
|
+
- Never hardcode secrets
|
|
87
|
+
- Use environment variables
|
|
88
|
+
|
|
89
|
+
---
|
|
90
|
+
|
|
91
|
+
## ๐ก Cursor Tips
|
|
92
|
+
|
|
93
|
+
- Use `@AGENT.md` to reference project context
|
|
94
|
+
- Use `@ai-instructions.md` for coding rules
|
|
95
|
+
- Run `/bootstrap` to start documentation generation
|
|
96
|
+
- Check `docs/` folder for detailed specifications
|
|
97
|
+
|
|
98
|
+
---
|
|
99
|
+
|
|
100
|
+
**Always reference `AGENT.md` for complete project understanding.**
|
|
101
|
+
|
|
102
|
+
**Generated by:** AI Flow v1.0.0
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
# Environment Configuration for {{PROJECT_NAME}}
|
|
2
|
+
# Copy this file to .env and fill in your values
|
|
3
|
+
|
|
4
|
+
# =============================================================================
|
|
5
|
+
# APPLICATION
|
|
6
|
+
# =============================================================================
|
|
7
|
+
NODE_ENV={{ENV_TYPE}}
|
|
8
|
+
PORT={{DEFAULT_PORT}}
|
|
9
|
+
APP_URL={{APP_URL}}
|
|
10
|
+
|
|
11
|
+
{{#IF LOG_LEVEL}}
|
|
12
|
+
# Logging
|
|
13
|
+
LOG_LEVEL={{LOG_LEVEL_DEFAULT}}
|
|
14
|
+
{{/IF}}
|
|
15
|
+
|
|
16
|
+
# =============================================================================
|
|
17
|
+
# DATABASE
|
|
18
|
+
# =============================================================================
|
|
19
|
+
{{#IF POSTGRESQL}}
|
|
20
|
+
DATABASE_URL=postgresql://{{DB_USER}}:{{DB_PASSWORD}}@{{DB_HOST}}:{{DB_PORT}}/{{DB_NAME}}
|
|
21
|
+
{{/IF}}
|
|
22
|
+
{{#IF MYSQL}}
|
|
23
|
+
DATABASE_URL=mysql://{{DB_USER}}:{{DB_PASSWORD}}@{{DB_HOST}}:{{DB_PORT}}/{{DB_NAME}}
|
|
24
|
+
{{/IF}}
|
|
25
|
+
{{#IF MONGODB}}
|
|
26
|
+
DATABASE_URL=mongodb://{{DB_USER}}:{{DB_PASSWORD}}@{{DB_HOST}}:{{DB_PORT}}/{{DB_NAME}}
|
|
27
|
+
{{/IF}}
|
|
28
|
+
|
|
29
|
+
DATABASE_POOL_MIN={{DB_POOL_MIN}}
|
|
30
|
+
DATABASE_POOL_MAX={{DB_POOL_MAX}}
|
|
31
|
+
|
|
32
|
+
# =============================================================================
|
|
33
|
+
# AUTHENTICATION
|
|
34
|
+
# =============================================================================
|
|
35
|
+
{{#IF JWT}}
|
|
36
|
+
JWT_SECRET=your-secret-key-here-change-in-production
|
|
37
|
+
JWT_EXPIRATION={{JWT_EXPIRATION}}
|
|
38
|
+
REFRESH_TOKEN_SECRET=your-refresh-secret-here-change-in-production
|
|
39
|
+
REFRESH_TOKEN_EXPIRATION={{REFRESH_TOKEN_EXPIRATION}}
|
|
40
|
+
{{/IF}}
|
|
41
|
+
|
|
42
|
+
{{#IF OAUTH}}
|
|
43
|
+
{{#EACH OAUTH_PROVIDER}}
|
|
44
|
+
{{PROVIDER_NAME_UPPER}}_CLIENT_ID=your-client-id
|
|
45
|
+
{{PROVIDER_NAME_UPPER}}_CLIENT_SECRET=your-client-secret
|
|
46
|
+
{{PROVIDER_NAME_UPPER}}_CALLBACK_URL={{CALLBACK_URL}}
|
|
47
|
+
{{/EACH}}
|
|
48
|
+
{{/IF}}
|
|
49
|
+
|
|
50
|
+
# =============================================================================
|
|
51
|
+
# REDIS / CACHE
|
|
52
|
+
# =============================================================================
|
|
53
|
+
{{#IF REDIS}}
|
|
54
|
+
REDIS_URL=redis://localhost:6379
|
|
55
|
+
REDIS_TTL={{REDIS_DEFAULT_TTL}}
|
|
56
|
+
{{/IF}}
|
|
57
|
+
|
|
58
|
+
# =============================================================================
|
|
59
|
+
# EXTERNAL SERVICES
|
|
60
|
+
# =============================================================================
|
|
61
|
+
|
|
62
|
+
{{#EACH EXTERNAL_SERVICE}}
|
|
63
|
+
# {{SERVICE_NAME}}
|
|
64
|
+
{{SERVICE_ENV_VARS_EXAMPLE}}
|
|
65
|
+
|
|
66
|
+
{{/EACH}}
|
|
67
|
+
|
|
68
|
+
# =============================================================================
|
|
69
|
+
# EMAIL
|
|
70
|
+
# =============================================================================
|
|
71
|
+
{{#IF EMAIL_SERVICE}}
|
|
72
|
+
EMAIL_HOST={{EMAIL_HOST}}
|
|
73
|
+
EMAIL_PORT={{EMAIL_PORT}}
|
|
74
|
+
EMAIL_USER=your-email@example.com
|
|
75
|
+
EMAIL_PASSWORD=your-email-password
|
|
76
|
+
EMAIL_FROM={{EMAIL_FROM}}
|
|
77
|
+
{{/IF}}
|
|
78
|
+
|
|
79
|
+
# =============================================================================
|
|
80
|
+
# FILE STORAGE
|
|
81
|
+
# =============================================================================
|
|
82
|
+
{{#IF S3}}
|
|
83
|
+
AWS_ACCESS_KEY_ID=your-access-key
|
|
84
|
+
AWS_SECRET_ACCESS_KEY=your-secret-key
|
|
85
|
+
AWS_REGION={{AWS_REGION}}
|
|
86
|
+
AWS_S3_BUCKET={{S3_BUCKET}}
|
|
87
|
+
{{/IF}}
|
|
88
|
+
|
|
89
|
+
{{#IF AZURE_BLOB}}
|
|
90
|
+
AZURE_STORAGE_ACCOUNT=your-account
|
|
91
|
+
AZURE_STORAGE_ACCESS_KEY=your-key
|
|
92
|
+
AZURE_STORAGE_CONTAINER={{CONTAINER_NAME}}
|
|
93
|
+
{{/IF}}
|
|
94
|
+
|
|
95
|
+
# =============================================================================
|
|
96
|
+
# SECURITY
|
|
97
|
+
# =============================================================================
|
|
98
|
+
CORS_ORIGIN={{CORS_ORIGIN_DEFAULT}}
|
|
99
|
+
RATE_LIMIT_WINDOW_MS={{RATE_LIMIT_WINDOW}}
|
|
100
|
+
RATE_LIMIT_MAX_REQUESTS={{RATE_LIMIT_MAX}}
|
|
101
|
+
|
|
102
|
+
{{#IF ENCRYPTION}}
|
|
103
|
+
ENCRYPTION_KEY=your-32-character-encryption-key-here
|
|
104
|
+
{{/IF}}
|
|
105
|
+
|
|
106
|
+
# =============================================================================
|
|
107
|
+
# MONITORING
|
|
108
|
+
# =============================================================================
|
|
109
|
+
{{#IF SENTRY}}
|
|
110
|
+
SENTRY_DSN=your-sentry-dsn
|
|
111
|
+
{{/IF}}
|
|
112
|
+
|
|
113
|
+
{{#IF DATADOG}}
|
|
114
|
+
DATADOG_API_KEY=your-datadog-api-key
|
|
115
|
+
{{/IF}}
|
|
116
|
+
|
|
117
|
+
# =============================================================================
|
|
118
|
+
# FEATURE FLAGS
|
|
119
|
+
# =============================================================================
|
|
120
|
+
{{#EACH FEATURE_FLAG}}
|
|
121
|
+
{{FLAG_NAME}}={{FLAG_DEFAULT}}
|
|
122
|
+
{{/EACH}}
|
|
@@ -0,0 +1,200 @@
|
|
|
1
|
+
# {{PROJECT_NAME}}
|
|
2
|
+
|
|
3
|
+
> {{PROJECT_DESCRIPTION}}
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## ๐ Overview
|
|
8
|
+
|
|
9
|
+
{{PROBLEM_STATEMENT}}
|
|
10
|
+
|
|
11
|
+
**Target Users:** {{TARGET_USERS_SUMMARY}}
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## โจ Features
|
|
16
|
+
|
|
17
|
+
{{#EACH FEATURE}}
|
|
18
|
+
|
|
19
|
+
- **{{FEATURE_NAME}}**: {{FEATURE_DESCRIPTION}}
|
|
20
|
+
{{/EACH}}
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## ๐๏ธ Tech Stack
|
|
25
|
+
|
|
26
|
+
- **Framework:** {{FRAMEWORK}} {{FRAMEWORK_VERSION}}
|
|
27
|
+
- **Language:** {{LANGUAGE}} {{LANGUAGE_VERSION}}
|
|
28
|
+
- **Database:** {{DATABASE}}
|
|
29
|
+
- **Authentication:** {{AUTH_METHOD}}
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## ๐ Getting Started
|
|
34
|
+
|
|
35
|
+
### Prerequisites
|
|
36
|
+
|
|
37
|
+
{{#EACH PREREQUISITE}}
|
|
38
|
+
|
|
39
|
+
- {{PREREQUISITE_NAME}} {{PREREQUISITE_VERSION}}
|
|
40
|
+
{{/EACH}}
|
|
41
|
+
|
|
42
|
+
### Installation
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
# Clone repository
|
|
46
|
+
git clone {{REPOSITORY_URL}}
|
|
47
|
+
cd {{PROJECT_DIR}}
|
|
48
|
+
|
|
49
|
+
# Install dependencies
|
|
50
|
+
{{INSTALL_COMMAND}}
|
|
51
|
+
|
|
52
|
+
# Copy environment variables
|
|
53
|
+
cp .env.example .env
|
|
54
|
+
|
|
55
|
+
# Edit .env with your configuration
|
|
56
|
+
# See .env.example for required variables
|
|
57
|
+
|
|
58
|
+
# Setup database
|
|
59
|
+
{{DB_SETUP_COMMAND}}
|
|
60
|
+
|
|
61
|
+
# Run migrations
|
|
62
|
+
{{MIGRATION_COMMAND}}
|
|
63
|
+
|
|
64
|
+
# Start development server
|
|
65
|
+
{{DEV_COMMAND}}
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
The application will be available at `{{DEV_URL}}`
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
|
|
72
|
+
## ๐งช Testing
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
# Run all tests
|
|
76
|
+
{{TEST_COMMAND}}
|
|
77
|
+
|
|
78
|
+
# Run with coverage
|
|
79
|
+
{{COVERAGE_COMMAND}}
|
|
80
|
+
|
|
81
|
+
# Run specific tests
|
|
82
|
+
{{TEST_SPECIFIC_COMMAND}}
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
## ๐ฆ Building
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
# Build for production
|
|
91
|
+
{{BUILD_COMMAND}}
|
|
92
|
+
|
|
93
|
+
# Start production server
|
|
94
|
+
{{PROD_COMMAND}}
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
---
|
|
98
|
+
|
|
99
|
+
## ๐ง Available Scripts
|
|
100
|
+
|
|
101
|
+
```bash
|
|
102
|
+
{{#EACH SCRIPT}}
|
|
103
|
+
# {{SCRIPT_DESCRIPTION}}
|
|
104
|
+
{{SCRIPT_COMMAND}}
|
|
105
|
+
|
|
106
|
+
{{/EACH}}
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
---
|
|
110
|
+
|
|
111
|
+
## ๐ Project Structure
|
|
112
|
+
|
|
113
|
+
```
|
|
114
|
+
{{PROJECT_STRUCTURE}}
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
---
|
|
118
|
+
|
|
119
|
+
## ๐ Documentation
|
|
120
|
+
|
|
121
|
+
- [Architecture](docs/architecture.md) - System architecture and design patterns
|
|
122
|
+
- [Data Model](docs/data-model.md) - Database schema and relationships
|
|
123
|
+
- [Business Flows](docs/business-flows.md) - Main business processes and flowcharts
|
|
124
|
+
- [API Reference](docs/api.md) - Endpoints and conventions
|
|
125
|
+
- [Code Standards](docs/code-standards.md) - Coding conventions and quality rules
|
|
126
|
+
- [Testing](docs/testing.md) - Testing strategy and requirements
|
|
127
|
+
- [Operations](docs/operations.md) - Deployment and operational procedures
|
|
128
|
+
- [Security](specs/security.md) - Security policies and compliance
|
|
129
|
+
- [Configuration](specs/configuration.md) - Environment configuration
|
|
130
|
+
- [Contributing](docs/contributing.md) - How to contribute
|
|
131
|
+
|
|
132
|
+
### For AI Assistants
|
|
133
|
+
|
|
134
|
+
- [AGENT.md](AGENT.md) - Universal AI configuration
|
|
135
|
+
- [AI Instructions](ai-instructions.md) - AI development rules and workflow
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
## ๐ Environment Variables
|
|
140
|
+
|
|
141
|
+
See `.env.example` for all required environment variables.
|
|
142
|
+
|
|
143
|
+
Critical variables:
|
|
144
|
+
{{#EACH CRITICAL_VAR}}
|
|
145
|
+
|
|
146
|
+
- `{{VAR_NAME}}` - {{VAR_DESCRIPTION}}
|
|
147
|
+
{{/EACH}}
|
|
148
|
+
|
|
149
|
+
---
|
|
150
|
+
|
|
151
|
+
## ๐ Deployment
|
|
152
|
+
|
|
153
|
+
See [docs/operations.md](docs/operations.md) for deployment procedures.
|
|
154
|
+
|
|
155
|
+
**Platform:** {{DEPLOYMENT_PLATFORM}}
|
|
156
|
+
|
|
157
|
+
**Environments:**
|
|
158
|
+
|
|
159
|
+
- Development: {{DEV_URL}}
|
|
160
|
+
- Staging: {{STAGING_URL}}
|
|
161
|
+
- Production: {{PRODUCTION_URL}}
|
|
162
|
+
|
|
163
|
+
---
|
|
164
|
+
|
|
165
|
+
## ๐ค Contributing
|
|
166
|
+
|
|
167
|
+
See [docs/contributing.md](docs/contributing.md) for contribution guidelines.
|
|
168
|
+
|
|
169
|
+
1. Fork the repository
|
|
170
|
+
2. Create feature branch (`git checkout -b feature/amazing-feature`)
|
|
171
|
+
3. Commit changes (`git commit -m 'feat: add amazing feature'`)
|
|
172
|
+
4. Push to branch (`git push origin feature/amazing-feature`)
|
|
173
|
+
5. Open Pull Request
|
|
174
|
+
|
|
175
|
+
---
|
|
176
|
+
|
|
177
|
+
## ๐ License
|
|
178
|
+
|
|
179
|
+
{{LICENSE}}
|
|
180
|
+
|
|
181
|
+
---
|
|
182
|
+
|
|
183
|
+
## ๐ฅ Team
|
|
184
|
+
|
|
185
|
+
{{#EACH TEAM_MEMBER}}
|
|
186
|
+
|
|
187
|
+
- **{{MEMBER_NAME}}** - {{MEMBER_ROLE}}
|
|
188
|
+
{{/EACH}}
|
|
189
|
+
|
|
190
|
+
---
|
|
191
|
+
|
|
192
|
+
## ๐ Support
|
|
193
|
+
|
|
194
|
+
{{#IF SUPPORT_EMAIL}}- Email: {{SUPPORT_EMAIL}}{{/IF}}
|
|
195
|
+
{{#IF SUPPORT_SLACK}}- Slack: {{SUPPORT_SLACK}}{{/IF}}
|
|
196
|
+
{{#IF ISSUE_TRACKER}}- Issues: {{ISSUE_TRACKER}}{{/IF}}
|
|
197
|
+
|
|
198
|
+
---
|
|
199
|
+
|
|
200
|
+
**Generated with** [AI Flow](https://github.com/victorvelazquez/ai-flow) ๐
|