appiq-solution 1.1.0 โ 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +48 -198
- package/package.json +1 -1
package/README.md
CHANGED
@@ -1,97 +1,34 @@
|
|
1
|
-
#
|
1
|
+
# ๐ฑ APPIQ SOLUTION: Flutter Mobile Development Extension
|
2
2
|
|
3
3
|
[](https://www.npmjs.com/package/appiq-solution)
|
4
4
|
[](LICENSE)
|
5
5
|
[](https://nodejs.org)
|
6
|
-
[](https://discord.gg/gk8jAdXWmj)
|
7
6
|
|
8
|
-
|
7
|
+
**Eine spezialisierte Erweiterung der BMAD Method fรผr Flutter Mobile App Entwicklung**
|
9
8
|
|
10
|
-
APPIQ SOLUTION
|
9
|
+
APPIQ SOLUTION erweitert die bewรคhrte BMAD Method um **erstklassige Flutter-Unterstรผtzung** mit Clean Architecture, Cubit patterns, BLoC state management, dependency injection und modernen Mobile Development Best Practices.
|
11
10
|
|
12
|
-
|
11
|
+
## ๐ Installation
|
13
12
|
|
14
|
-
**
|
15
|
-
|
16
|
-
โญ **If you find this project helpful or useful, please give it a star in the upper right hand corner!** It helps others discover APPIQ-METHOD and you will be notified of updates!
|
17
|
-
|
18
|
-
## Overview
|
19
|
-
|
20
|
-
**APPIQ Method's Two Key Innovations:**
|
21
|
-
|
22
|
-
**1. Agentic Planning:** Dedicated agents (Analyst, PM, Architect) collaborate with you to create detailed, consistent PRDs and Architecture documents. Through advanced prompt engineering and human-in-the-loop refinement, these planning agents produce comprehensive specifications that go far beyond generic AI task generation.
|
23
|
-
|
24
|
-
**2. Context-Engineered Development:** The Scrum Master agent then transforms these detailed plans into hyper-detailed development stories that contain everything the Dev agent needs - full context, implementation details, and architectural guidance embedded directly in story files.
|
25
|
-
|
26
|
-
This two-phase approach eliminates both **planning inconsistency** and **context loss** - the biggest problems in AI-assisted development. Your Dev agent opens a story file with complete understanding of what to build, how to build it, and why.
|
27
|
-
|
28
|
-
**๐ [See the complete workflow in the User Guide](bmad-core/user-guide.md)** - Planning phase, development cycle, and all agent roles
|
29
|
-
|
30
|
-
## Quick Navigation
|
31
|
-
|
32
|
-
### Understanding the APPIQ Workflow
|
33
|
-
|
34
|
-
**Before diving in, review these critical workflow diagrams that explain how APPIQ works:**
|
35
|
-
|
36
|
-
1. **[Planning Workflow (Web UI)](bmad-core/user-guide.md#the-planning-workflow-web-ui)** - How to create PRD and Architecture documents
|
37
|
-
2. **[Core Development Cycle (IDE)](bmad-core/user-guide.md#the-core-development-cycle-ide)** - How SM, Dev, and QA agents collaborate through story files
|
38
|
-
|
39
|
-
> โ ๏ธ **These diagrams explain 90% of BMad Method Agentic Agile flow confusion** - Understanding the PRD+Architecture creation and the SM/Dev/QA workflow and how agents pass notes through story files is essential - and also explains why this is NOT taskmaster or just a simple task runner!
|
40
|
-
|
41
|
-
### What would you like to do?
|
42
|
-
|
43
|
-
- **[Install and Build software with Full Stack Agile AI Team](#quick-start)** โ Quick Start Instruction
|
44
|
-
- **[Learn how to use BMad](bmad-core/user-guide.md)** โ Complete user guide and walkthrough
|
45
|
-
- **[See available AI agents](/bmad-core/agents))** โ Specialized roles for your team
|
46
|
-
- **[Explore non-technical uses](#-beyond-software-development---expansion-packs)** โ Creative writing, business, wellness, education
|
47
|
-
- **[Create my own AI agents](#creating-your-own-expansion-pack)** โ Build agents for your domain
|
48
|
-
- **[Browse ready-made expansion packs](expansion-packs/)** โ Game dev, DevOps, infrastructure and get inspired with ideas and examples
|
49
|
-
- **[Understand the architecture](docs/core-architecture.md)** โ Technical deep dive
|
50
|
-
- **[Join the community](https://discord.gg/gk8jAdXWmj)** โ Get help and share ideas
|
51
|
-
|
52
|
-
## Important: Keep Your BMad Installation Updated
|
53
|
-
|
54
|
-
**Stay up-to-date effortlessly!** If you already have BMad-Method installed in your project, simply run:
|
55
|
-
|
56
|
-
```bash
|
57
|
-
npx bmad-method install
|
58
|
-
# OR
|
59
|
-
git pull
|
60
|
-
npm run install:bmad
|
61
|
-
```
|
62
|
-
|
63
|
-
This will:
|
64
|
-
|
65
|
-
- โ
Automatically detect your existing v4 installation
|
66
|
-
- โ
Update only the files that have changed and add new files
|
67
|
-
- โ
Create `.bak` backup files for any custom modifications you've made
|
68
|
-
- โ
Preserve your project-specific configurations
|
69
|
-
|
70
|
-
This makes it easy to benefit from the latest improvements, bug fixes, and new agents without losing your customizations!
|
71
|
-
|
72
|
-
## Quick Start
|
73
|
-
|
74
|
-
### ๐ NEW: One-Command Installation (10 seconds setup)
|
75
|
-
|
76
|
-
**The simplest way to get started with APPIQ Solution:**
|
13
|
+
**Einfach und schnell:**
|
77
14
|
|
78
15
|
```bash
|
79
16
|
npx appiq-solution install
|
80
17
|
```
|
81
18
|
|
82
|
-
**
|
83
|
-
- โ
**Multi-IDE Support**:
|
19
|
+
**Der Smart Installer konfiguriert:**
|
20
|
+
- โ
**Multi-IDE Support**: Cursor, Claude Code, Windsurf, VS Code + Cline, und mehr
|
84
21
|
- โ
**Auto-detect Tech Stack**: Flutter, React, Vue, Next.js, Angular, Fullstack, API-only
|
85
|
-
- โ
**Smart MCP Integration**: Agents
|
86
|
-
- โ
**Planning Workflow**:
|
87
|
-
- โ
**Full BMAD Flow**: Document sharding,
|
88
|
-
- โ
**๐ฏ Advanced Flutter Support**: Dart MCP Server integration, Clean Architecture, Cubit patterns, BLoC state management, dependency injection
|
22
|
+
- โ
**Smart MCP Integration**: Agents wissen welche MCP Server sie nutzen kรถnnen (keine Auto-Config)
|
23
|
+
- โ
**Planning Workflow**: Projektidee โ Plan-Generierung โ Freigabe โ Entwicklung
|
24
|
+
- โ
**Full BMAD Flow**: Document sharding, Agent orchestration, Entwicklungszyklus
|
25
|
+
- โ
**๐ฏ Advanced Flutter Support**: Dart MCP Server integration, Clean Architecture, Cubit patterns, BLoC state management, dependency injection mit GetIt, proper testing strategies
|
89
26
|
- โ
**Modern Web**: shadcn/ui, v0.dev, Tailwind CSS integration
|
90
|
-
- โ
**Security First**:
|
27
|
+
- โ
**Security First**: Keine API Keys werden gespeichert oder automatisch konfiguriert
|
91
28
|
|
92
|
-
### ๐ฏ **
|
29
|
+
### ๐ฏ **Verfรผgbare MCP Server**
|
93
30
|
|
94
|
-
|
31
|
+
Deine Agents kennen diese MCP Server (du konfigurierst sie manuell in deiner IDE):
|
95
32
|
|
96
33
|
- **๐ง Sequential Thinking**: Complex problem solving
|
97
34
|
- **๐ Puppeteer**: Browser automation and testing
|
@@ -104,134 +41,55 @@ Your agents will know about these MCP servers (you configure them manually in yo
|
|
104
41
|
- **๐ Context7**: Up-to-date library documentation
|
105
42
|
- **๐ณ Stripe**: Payment integration
|
106
43
|
|
107
|
-
|
44
|
+
**In deiner IDE (Cursor, Claude, etc.):**
|
108
45
|
```
|
109
46
|
@smart-launcher
|
110
47
|
```
|
111
48
|
|
112
|
-
|
113
|
-
|
114
|
-
### ๐ฑ **Flutter Mobile Development - First Class Support**
|
115
|
-
|
116
|
-
APPIQ Solution provides **industry-leading Flutter development support** with:
|
117
|
-
|
118
|
-
- **๐๏ธ Clean Architecture**: Domain-driven design, proper layer separation
|
119
|
-
- **๐ State Management**: Cubit patterns, BLoC integration, proper state flows
|
120
|
-
- **๐ ๏ธ Best Practices**: Dependency injection with GetIt, null safety, proper error handling
|
121
|
-
- **๐จ Material 3**: Modern UI components, theming, responsive design
|
122
|
-
- **๐งช Testing**: Unit tests, widget tests, integration tests, proper mocking
|
123
|
-
- **๐ง DevTools**: Dart MCP Server integration, hot reload optimization
|
124
|
-
- **๐ฆ Package Management**: Curated package recommendations, version management
|
125
|
-
|
126
|
-
**Get started with Flutter projects:**
|
127
|
-
```bash
|
128
|
-
npx appiq-solution install # Auto-detects Flutter projects
|
129
|
-
```
|
130
|
-
|
131
|
-
### Alternative: Traditional BMAD Installation
|
132
|
-
|
133
|
-
**For the original BMAD-METHOD experience:**
|
134
|
-
|
135
|
-
```bash
|
136
|
-
npx bmad-method install
|
137
|
-
# OR if you already have BMad installed:
|
138
|
-
git pull
|
139
|
-
npm run install:bmad
|
140
|
-
```
|
141
|
-
|
142
|
-
**Prerequisites**: [Node.js](https://nodejs.org) v20+ required
|
143
|
-
|
144
|
-
### ๐ **Upgrading from BMAD-METHOD?**
|
145
|
-
|
146
|
-
APPIQ Solution is fully compatible! You can:
|
147
|
-
- โ
**Keep existing projects** - APPIQ works alongside BMAD
|
148
|
-
- โ
**Use both installers** - `npx bmad-method install` for traditional, `npx appiq-solution install` for modern
|
149
|
-
- โ
**Migrate gradually** - Start new projects with APPIQ, keep existing with BMAD
|
49
|
+
## ๐ฑ Flutter Features
|
150
50
|
|
151
|
-
|
51
|
+
- **๐๏ธ Clean Architecture**: Domain-driven Design, saubere Layer-Trennung
|
52
|
+
- **๐ State Management**: Cubit patterns, BLoC integration
|
53
|
+
- **๐ ๏ธ Best Practices**: GetIt dependency injection, null safety
|
54
|
+
- **๐จ Material 3**: Moderne UI components, theming
|
55
|
+
- **๐งช Testing**: Unit-, Widget- und Integration-Tests
|
56
|
+
- **๐ฆ Package Management**: Kuratierte Package-Empfehlungen
|
152
57
|
|
153
|
-
|
154
|
-
2. **Create AI agent**: Create a new Gemini Gem or CustomGPT
|
155
|
-
3. **Upload & configure**: Upload the file and set instructions: "Your critical operating instructions are attached, do not break character as directed"
|
156
|
-
4. **Start Ideating and Planning**: Start chatting! Type `*help` to see available commands or pick an agent like `*analyst` to start right in on creating a brief.
|
157
|
-
5. **CRITICAL**: Talk to BMad Orchestrator in the web at ANY TIME (#bmad-orchestrator command) and ask it questions about how this all works!
|
158
|
-
6. **When to move to the IDE**: Once you have your PRD, Architecture, optional UX and Briefs - its time to switch over to the IDE to shard your docs, and start implementing the actual code! See the [User guide](bmad-core/user-guide.md) for more details
|
58
|
+
## ๐๏ธ Codebase Context Management
|
159
59
|
|
160
|
-
|
60
|
+
**Automatischer Context Export nach jedem Feature/Milestone:**
|
161
61
|
|
162
62
|
```bash
|
163
|
-
|
164
|
-
npm run install:bmad # build and install all to a destination folder
|
165
|
-
```
|
166
|
-
|
167
|
-
## ๐ Beyond Software Development - Expansion Packs
|
168
|
-
|
169
|
-
Both APPIQ Solution and BMad's natural language framework work in ANY domain. **Specially optimized for mobile development**, expansion packs provide specialized AI agents for:
|
170
|
-
|
171
|
-
- **๐ฑ Flutter Mobile Development** - Clean Architecture, Cubit patterns, BLoC state management, dependency injection, proper testing, null safety, and Material 3 design integration
|
172
|
-
- **๐ฎ Game Development** - Unity 2D, Phaser.js game creation
|
173
|
-
- **๐๏ธ DevOps & Infrastructure** - Platform engineering, deployment automation
|
174
|
-
- **โ๏ธ Creative Writing** - Story development, character creation
|
175
|
-
- **๐ผ Business Strategy** - Planning, analysis, decision-making
|
176
|
-
- **๐ฅ Health & Wellness** - Personal development, fitness planning
|
177
|
-
- **๐ Education** - Learning paths, curriculum development
|
178
|
-
|
179
|
-
[See the Expansion Packs Guide](docs/expansion-packs.md) and learn to create your own!
|
180
|
-
|
181
|
-
## Codebase Flattener Tool
|
182
|
-
|
183
|
-
The BMad-Method includes a powerful codebase flattener tool designed to prepare your project files for AI model consumption. This tool aggregates your entire codebase into a single XML file, making it easy to share your project context with AI assistants for analysis, debugging, or development assistance.
|
184
|
-
|
185
|
-
### Features
|
186
|
-
|
187
|
-
- **AI-Optimized Output**: Generates clean XML format specifically designed for AI model consumption
|
188
|
-
- **Smart Filtering**: Automatically respects `.gitignore` patterns to exclude unnecessary files
|
189
|
-
- **Binary File Detection**: Intelligently identifies and excludes binary files, focusing on source code
|
190
|
-
- **Progress Tracking**: Real-time progress indicators and comprehensive completion statistics
|
191
|
-
- **Flexible Output**: Customizable output file location and naming
|
192
|
-
|
193
|
-
### Usage
|
194
|
-
|
195
|
-
```bash
|
196
|
-
# Basic usage - creates flattened-codebase.xml in current directory
|
63
|
+
# Manuell ausfรผhren
|
197
64
|
npx bmad-method flatten
|
198
65
|
|
199
|
-
#
|
200
|
-
npx bmad-method flatten --
|
201
|
-
|
202
|
-
|
203
|
-
|
204
|
-
|
205
|
-
npx bmad-method flatten
|
206
|
-
|
207
|
-
|
208
|
-
|
66
|
+
# Mit custom Output (fรผr AI-Agents)
|
67
|
+
npx bmad-method flatten --output context/current-codebase.xml
|
68
|
+
|
69
|
+
# Automatisch in package.json scripts:
|
70
|
+
{
|
71
|
+
"scripts": {
|
72
|
+
"flatten": "npx bmad-method flatten --output context/milestone-$(date +%Y%m%d).xml",
|
73
|
+
"posttest": "npm run flatten",
|
74
|
+
"postbuild": "npm run flatten"
|
75
|
+
}
|
76
|
+
}
|
209
77
|
```
|
210
78
|
|
211
|
-
|
79
|
+
**Wo wird es gespeichert:**
|
80
|
+
- **Standard**: `flattened-codebase.xml` im aktuellen Verzeichnis
|
81
|
+
- **Custom**: Beliebiger Pfad mit `--output` Parameter
|
82
|
+
- **Empfehlung**: `context/` Ordner fรผr bessere Organisation
|
212
83
|
|
213
|
-
|
84
|
+
**Nutzen fรผr Flutter-Entwicklung:**
|
85
|
+
- โ
AI Agents haben immer aktuellen Codebase-Context
|
86
|
+
- โ
Perfekt fรผr Code Reviews und Architektur-Diskussionen
|
87
|
+
- โ
Einfacher Knowledge Transfer zwischen Team-Mitgliedern
|
214
88
|
|
215
|
-
|
216
|
-
๐ Completion Summary:
|
217
|
-
โ
Successfully processed 156 files into flattened-codebase.xml
|
218
|
-
๐ Output file: /path/to/your/project/flattened-codebase.xml
|
219
|
-
๐ Total source size: 2.3 MB
|
220
|
-
๐ Generated XML size: 2.1 MB
|
221
|
-
๐ Total lines of code: 15,847
|
222
|
-
๐ข Estimated tokens: 542,891
|
223
|
-
๐ File breakdown: 142 text, 14 binary, 0 errors
|
224
|
-
```
|
89
|
+
## ๐ Dokumentation
|
225
90
|
|
226
|
-
|
227
|
-
|
228
|
-
## Documentation & Resources
|
229
|
-
|
230
|
-
### Essential Guides
|
231
|
-
|
232
|
-
- ๐ **[User Guide](bmad-core/user-guide.md)** - Complete walkthrough from project inception to completion
|
233
|
-
- ๐๏ธ **[Core Architecture](docs/core-architecture.md)** - Technical deep dive and system design
|
234
|
-
- ๐ **[Expansion Packs Guide](docs/expansion-packs.md)** - Extend BMad to any domain beyond software development
|
91
|
+
- ๐ **[User Guide](bmad-core/user-guide.md)** - Komplette Anleitung zur Flutter-Entwicklung mit AI Agents
|
92
|
+
- ๐ฑ **[Flutter Expansion Pack](expansion-packs/bmad-flutter-mobile-dev/)** - Spezialisierte Flutter Agents und Templates
|
235
93
|
|
236
94
|
## Support
|
237
95
|
|
@@ -240,16 +98,8 @@ The generated XML file contains all your project's source code in a structured f
|
|
240
98
|
- ๐ฌ [Discussions](https://github.com/bmadcode/bmad-method/discussions)
|
241
99
|
- ๐ [](https://www.paypal.com/paypalme/vhermann)
|
242
100
|
|
243
|
-
## Contributing
|
244
|
-
|
245
|
-
**We're excited about contributions and welcome your ideas, improvements, and expansion packs!** ๐
|
246
|
-
|
247
|
-
๐ **[Read CONTRIBUTING.md](CONTRIBUTING.md)** - Complete guide to contributing, including guidelines, process, and requirements
|
248
|
-
|
249
101
|
## License
|
250
102
|
|
251
103
|
MIT License - see [LICENSE](LICENSE) for details.
|
252
104
|
|
253
|
-
|
254
|
-
|
255
|
-
<sub>Built with โค๏ธ for the AI-assisted development community</sub>
|
105
|
+
<sub>Built with โค๏ธ for Flutter developers and the AI-assisted development community</sub>
|
package/package.json
CHANGED