bmad-odoo 1.0.0 → 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/README.md CHANGED
@@ -12,11 +12,17 @@
12
12
 
13
13
  1. [Giới Thiệu](#giới-thiệu)
14
14
  2. [Cài Đặt](#cài-đặt)
15
- 3. [Cấu Hình](#cấu-hình)
16
- 4. [Các Agents](#các-agents)
17
- 5. [Workflows](#workflows)
18
- 6. [Quy Trình Làm Việc](#quy-trình-làm-việc)
19
- 7. [Tài Liệu Tham Khảo](#tài-liệu-tham-khảo)
15
+ 3. [Hướng Dẫn Chi Tiết](#-hướng-dẫn-chi-tiết)
16
+ 4. [Các Lệnh Phổ Biến](#-các-lệnh-phổ-biến)
17
+ 5. [Use Cases](#-use-cases)
18
+ 6. [Cấu Hình](#cấu-hình)
19
+ 7. [Các Agents](#các-agents)
20
+ 8. [Workflows](#workflows)
21
+ 9. [Quy Trình Làm Việc](#quy-trình-làm-việc)
22
+ 10. [Cấu Trúc Thư Mục](#cấu-trúc-thư-mục)
23
+ 11. [Troubleshooting](#-troubleshooting)
24
+ 12. [FAQ](#-faq)
25
+ 13. [Tài Liệu Tham Khảo](#tài-liệu-tham-khảo)
20
26
 
21
27
  ---
22
28
 
@@ -40,17 +46,38 @@
40
46
 
41
47
  - Node.js 18+
42
48
  - Odoo 16.0+ hoặc 17.0
43
- - AI IDE hỗ trợ (Cursor, VS Code với extension AI)
49
+ - AI IDE hỗ trợ (Antigravity/Gemini, Cursor, VS Code, Windsurf)
44
50
 
45
51
  ### Cách 1: Cài Đặt từ NPM (Khuyến nghị)
46
52
 
47
53
  ```bash
48
- # Cài đặt package
54
+ # Trong thư mục dự án Odoo của bạn
49
55
  npm install bmad-odoo
56
+ ```
57
+
58
+ **Post-install sẽ tự động hỏi bạn chọn IDE:**
59
+ ```
60
+ Chọn IDE bạn đang sử dụng:
61
+ 1. VS Code - Visual Studio Code với extensions AI
62
+ 2. Cursor - Cursor AI IDE
63
+ 3. Antigravity - Google Gemini Antigravity Agent
64
+ 4. Windsurf - Windsurf AI IDE
65
+ 5. Tất cả - Setup cho tất cả IDEs
66
+
67
+ Nhập số (1-5) [mặc định: 3]:
68
+ ```
69
+
70
+ **Package sẽ tự động tạo:**
71
+ - ✅ Thư mục `_bmad-odoo/` (symlink hoặc copy từ `node_modules/`)
72
+ - ✅ Thư mục `_bmad-odoo-output/` với cấu trúc con cho artifacts
73
+ - ✅ Workflows vào `.agent/workflows/` (hoặc IDE bạn chọn)
74
+ - ✅ Các slash commands: `/analyst`, `/dev`, `/pm`, ...
50
75
 
51
- # Package sẽ tự động:
52
- # - Tạo thư mục .agent/workflows/
53
- # - Cài đặt các slash commands cho agents
76
+ ### Chạy Lại Setup (nếu cần)
77
+
78
+ ```bash
79
+ # Nếu muốn đổi IDE hoặc setup lại
80
+ npx bmad-odoo-setup
54
81
  ```
55
82
 
56
83
  ### Cách 2: Cài Đặt Thủ Công
@@ -61,6 +88,10 @@ git clone https://github.com/phamdungtk/bmad-odoo.git
61
88
 
62
89
  # Copy vào node_modules
63
90
  cp -r bmad-odoo node_modules/
91
+
92
+ # Chạy setup
93
+ cd bmad-odoo
94
+ npm run setup
64
95
  ```
65
96
 
66
97
  ---
@@ -92,6 +123,256 @@ odoo:
92
123
 
93
124
  ---
94
125
 
126
+ ## 🚀 Hướng Dẫn Chi Tiết
127
+
128
+ ### Bước 1: Cài Đặt Package
129
+
130
+ ```bash
131
+ # Di chuyển đến thư mục dự án Odoo của bạn
132
+ cd D:\MyOdooProject
133
+
134
+ # Khởi tạo package.json nếu chưa có
135
+ npm init -y
136
+
137
+ # Cài đặt bmad-odoo
138
+ npm install bmad-odoo
139
+ ```
140
+
141
+ **Kết quả:**
142
+ ```
143
+ + bmad-odoo@1.0.0
144
+ added 1 package
145
+ ```
146
+
147
+ ### Bước 2: Interactive Setup (Tự Động)
148
+
149
+ Ngay sau khi cài đặt, **post-install script sẽ tự động chạy**:
150
+
151
+ ```
152
+ ╔════════════════════════════════════════════════════════════╗
153
+ ║ 🚀 BMAD-Odoo Interactive Setup ║
154
+ ╚════════════════════════════════════════════════════════════╝
155
+
156
+ Chọn IDE bạn đang sử dụng:
157
+
158
+ 1. VS Code - Visual Studio Code với extensions AI
159
+ 2. Cursor - Cursor AI IDE
160
+ 3. Antigravity - Google Gemini Antigravity Agent
161
+ 4. Windsurf - Windsurf AI IDE
162
+ 5. Tất cả - Setup cho tất cả IDEs
163
+
164
+ Nhập số (1-5) [mặc định: 3]:
165
+ ```
166
+
167
+ **Nhập số và Enter:**
168
+ ```bash
169
+ 3 # Chọn Antigravity (hoặc IDE bạn đang dùng)
170
+ ```
171
+
172
+ ### Bước 3: Quá Trình Setup (Tự Động)
173
+
174
+ Script sẽ tự động thực hiện:
175
+
176
+ ```
177
+ 📌 Đã chọn: Antigravity (Gemini)
178
+
179
+ [1/3] Tạo thư mục _bmad-odoo...
180
+ ✅ Đã tạo symlink: _bmad-odoo -> node_modules/bmad-odoo
181
+
182
+ [2/3] Tạo thư mục _bmad-odoo-output...
183
+ ✅ Đã tạo: _bmad-odoo-output/
184
+
185
+ [3/3] Tạo workflow files...
186
+ ✅ Đã tạo 10 workflows cho Antigravity (Gemini)
187
+
188
+ ╔════════════════════════════════════════════════════════════╗
189
+ ║ ✅ BMAD-Odoo Setup Hoàn Tất! ║
190
+ ╚════════════════════════════════════════════════════════════╝
191
+ ```
192
+
193
+ ### Bước 4: Kiểm Tra Cấu Trúc Đã Tạo
194
+
195
+ ```bash
196
+ # Kiểm tra thư mục project
197
+ ls -la
198
+ ```
199
+
200
+ **Cấu trúc sau khi setup:**
201
+ ```
202
+ MyOdooProject/
203
+ ├── node_modules/
204
+ │ └── bmad-odoo/ # Package gốc từ npm
205
+ ├── _bmad-odoo/ # ✨ Symlink/copy để dễ access
206
+ ├── _bmad-odoo-output/ # ✨ Thư mục output cho artifacts
207
+ │ ├── planning-artifacts/
208
+ │ ├── implementation-artifacts/
209
+ │ ├── test-artifacts/
210
+ │ └── documentation/
211
+ ├── .agent/ # ✨ Workflows cho Antigravity
212
+ │ └── workflows/
213
+ │ ├── analyst.md
214
+ │ ├── architect.md
215
+ │ ├── dev.md
216
+ │ ├── pm.md
217
+ │ ├── sm.md
218
+ │ ├── tea.md
219
+ │ ├── ux-designer.md
220
+ │ ├── quick-flow-solo-dev.md
221
+ │ ├── tech-writer.md
222
+ │ └── bmad-core-workflows-party-mode.md
223
+ └── package.json
224
+ ```
225
+
226
+ ### Bước 5: Sử Dụng Agents
227
+
228
+ Mở AI IDE của bạn (Antigravity/Gemini, Cursor, etc.) và gõ:
229
+
230
+ ```bash
231
+ /analyst # Kích hoạt Business Analyst (Sofia)
232
+ /architect # Kích hoạt Technical Architect (Antonio)
233
+ /dev # Kích hoạt Developer (Carlos)
234
+ /pm # Kích hoạt Product Manager (Maria)
235
+ /sm # Kích hoạt Scrum Master (Diego)
236
+ /tea # Kích hoạt Test Architect (Elena)
237
+ /ux-designer # Kích hoạt UX Designer (Sally)
238
+ /quick-flow-solo-dev # Kích hoạt Quick Flow Dev (Barry)
239
+ /tech-writer # Kích hoạt Tech Writer (Paige)
240
+ ```
241
+
242
+ ---
243
+
244
+ ## 🔧 Các Lệnh Phổ Biến
245
+
246
+ ### Chạy Lại Setup (Đổi IDE hoặc Thêm IDE)
247
+
248
+ Nếu bạn muốn:
249
+ - Đổi sang IDE khác
250
+ - Thêm workflows cho IDE mới
251
+ - Setup lại từ đầu
252
+
253
+ ```bash
254
+ # Chạy interactive setup
255
+ npx bmad-odoo-setup
256
+
257
+ # Hoặc
258
+ npm run setup
259
+ ```
260
+
261
+ **Script sẽ hỏi lại IDE và tạo workflows cho IDE đó.**
262
+
263
+ ### Xem Thông Tin Package
264
+
265
+ ```bash
266
+ # Xem version đã cài
267
+ npm list bmad-odoo
268
+
269
+ # Xem thông tin từ npm
270
+ npm view bmad-odoo
271
+
272
+ # Xem tất cả versions có sẵn
273
+ npm view bmad-odoo versions
274
+ ```
275
+
276
+ ### Update Package
277
+
278
+ ```bash
279
+ # Update lên version mới nhất
280
+ npm update bmad-odoo
281
+
282
+ # Hoặc cài lại với version cụ thể
283
+ npm install bmad-odoo@latest
284
+ ```
285
+
286
+ ### Xóa và Cài Lại
287
+
288
+ ```bash
289
+ # Xóa package và thư mục đã tạo
290
+ npm uninstall bmad-odoo
291
+ rm -rf _bmad-odoo _bmad-odoo-output .agent/workflows
292
+
293
+ # Cài lại
294
+ npm install bmad-odoo
295
+ ```
296
+
297
+ ---
298
+
299
+ ## 💡 Use Cases
300
+
301
+ ### Case 1: Phát Triển Module Odoo Mới
302
+
303
+ ```bash
304
+ # 1. Cài đặt bmad-odoo
305
+ npm install bmad-odoo
306
+
307
+ # 2. Kích hoạt Business Analyst để phân tích yêu cầu
308
+ /analyst
309
+ > AP # Chọn [AP] Analyze Process
310
+
311
+ # 3. Kích hoạt Architect để thiết kế
312
+ /architect
313
+ > CO # Chọn [CO] Create Odoo Addon
314
+
315
+ # 4. Kích hoạt Developer để code
316
+ /dev
317
+ > DS # Chọn [DS] Dev Story
318
+ ```
319
+
320
+ ### Case 2: Setup Cho Team (Multi-IDE)
321
+
322
+ ```bash
323
+ # Cài đặt package
324
+ npm install bmad-odoo
325
+
326
+ # Khi setup, chọn option 5 (Tất cả)
327
+ # Script sẽ tạo workflows cho:
328
+ # - VS Code (.vscode/workflows/)
329
+ # - Cursor (.cursor/workflows/)
330
+ # - Antigravity (.agent/workflows/)
331
+ # - Windsurf (.windsurf/workflows/)
332
+
333
+ # Team members dùng IDE khác nhau đều có thể làm việc
334
+ ```
335
+
336
+ ### Case 3: CI/CD Integration
337
+
338
+ Nếu cài đặt trong CI/CD (non-interactive):
339
+
340
+ ```bash
341
+ # Script sẽ tự động chọn Antigravity (default)
342
+ npm install bmad-odoo
343
+
344
+ # Hoặc set biến môi trường (nếu support sau)
345
+ BMAD_IDE=cursor npm install bmad-odoo
346
+ ```
347
+
348
+ ---
349
+
350
+ ## Cấu Hình
351
+
352
+ ### File Cấu Hình Chính
353
+
354
+ Chỉnh sửa file `_bmad-odoo/bmm/config.yaml`:
355
+
356
+ ```yaml
357
+ # Thông tin người dùng
358
+ user_name: "Tên của bạn"
359
+ communication_language: "Tiếng Việt"
360
+
361
+ # Thư mục đầu ra
362
+ output_folder: "_bmad-odoo-output"
363
+ planning_artifacts: "_bmad-odoo-output/planning-artifacts"
364
+ implementation_artifacts: "_bmad-odoo-output/implementation-artifacts"
365
+
366
+ # Cấu hình Odoo
367
+ odoo:
368
+ version: "17.0"
369
+ edition: "community" # community hoặc enterprise
370
+ customModulesPath: "addons_custom"
371
+ oca_path: "addons_oca"
372
+ ```
373
+
374
+ ---
375
+
95
376
  ## Các Agents
96
377
 
97
378
  ### Danh Sách Agents
@@ -283,35 +564,161 @@ _bmad-odoo/
283
564
 
284
565
  ---
285
566
 
567
+ ## 🔧 Troubleshooting
568
+
569
+ ### Lỗi: "Cannot find module 'bmad-odoo'"
570
+
571
+ **Nguyên nhân:** Package chưa được cài hoặc cài sai vị trí
572
+
573
+ **Giải pháp:**
574
+ ```bash
575
+ # Kiểm tra package.json có bmad-odoo chưa
576
+ cat package.json | grep bmad-odoo
577
+
578
+ # Cài lại
579
+ npm install bmad-odoo
580
+
581
+ # Verify
582
+ npm list bmad-odoo
583
+ ```
584
+
585
+ ### Lỗi: "Permission denied" khi tạo symlink
586
+
587
+ **Nguyên nhân:** Windows yêu cầu admin rights để tạo symlink
588
+
589
+ **Giải pháp:**
590
+ Script tự động fallback sang copy folder. Không cần làm gì.
591
+
592
+ **Kiểm tra:**
593
+ ```bash
594
+ # Kiểm tra _bmad-odoo có phải symlink không
595
+ ls -la _bmad-odoo
596
+
597
+ # Nếu symlink: lrwxrwxrwx ... _bmad-odoo -> node_modules/bmad-odoo
598
+ # Nếu copy: drwxr-xr-x ... _bmad-odoo
599
+ ```
600
+
601
+ ### Lỗi: Post-install không chạy
602
+
603
+ **Nguyên nhân:** npm config hoặc chạy với `--ignore-scripts`
604
+
605
+ **Giải pháp:**
606
+ ```bash
607
+ # Chạy thủ công
608
+ npx bmad-odoo-setup
609
+
610
+ # Hoặc
611
+ npm run setup
612
+ ```
613
+
614
+ ### Lỗi: Workflows không xuất hiện trong IDE
615
+
616
+ **Nguyên nhân:**
617
+ - IDE chưa reload
618
+ - Workflows tạo sai folder
619
+
620
+ **Giải pháp:**
621
+ ```bash
622
+ # 1. Kiểm tra workflows đã tạo chưa
623
+ ls .agent/workflows # Antigravity
624
+ ls .cursor/workflows # Cursor
625
+ ls .vscode/workflows # VS Code
626
+
627
+ # 2. Nếu chưa có, chạy lại setup
628
+ npx bmad-odoo-setup
629
+
630
+ # 3. Reload IDE
631
+ # - Antigravity: Refresh browser
632
+ # - Cursor: Cmd/Ctrl + Shift + P → "Reload Window"
633
+ # - VS Code: Cmd/Ctrl + Shift + P → "Reload Window"
634
+ ```
635
+
636
+ ### Lỗi: Output folder không được tạo
637
+
638
+ **Giải pháp:**
639
+ ```bash
640
+ # Tạo thủ công
641
+ mkdir -p _bmad-odoo-output/{planning-artifacts,implementation-artifacts,test-artifacts,documentation}
642
+
643
+ # Hoặc chạy lại setup
644
+ npx bmad-odoo-setup
645
+ ```
646
+
647
+ ### Muốn đổi IDE sau khi đã setup
648
+
649
+ **Giải pháp:**
650
+ ```bash
651
+ # Chạy lại setup và chọn IDE mới
652
+ npx bmad-odoo-setup
653
+
654
+ # Hoặc chọn "Tất cả" để có workflows cho nhiều IDE
655
+ ```
656
+
657
+ ---
658
+
659
+ ## ❓ FAQ
660
+
661
+ **Q: Có thể dùng nhiều IDE cùng lúc không?**
662
+
663
+ A: Có! Chọn option 5 (Tất cả) khi setup, hoặc chạy `npx bmad-odoo-setup` nhiều lần với IDE khác nhau.
664
+
665
+ **Q: _bmad-odoo và node_modules/bmad-odoo khác gì?**
666
+
667
+ A:
668
+ - `node_modules/bmad-odoo`: Package gốc từ npm
669
+ - `_bmad-odoo`: Symlink (hoặc copy) để dễ access, tránh phải gõ đường dẫn dài
670
+
671
+ **Q: Có thể commit _bmad-odoo-output vào git không?**
672
+
673
+ A: Có thể! Folder này chứa artifacts (PRD, architecture docs, stories) do agents tạo ra. Commit chúng giúp team tracking tiến độ.
674
+
675
+ **Q: Làm sao để update lên version mới?**
676
+
677
+ A: `npm update bmad-odoo` hoặc `npm install bmad-odoo@latest`
678
+
679
+ **Q: Package này hoạt động offline không?**
680
+
681
+ A: Sau khi cài, package hoạt động offline (không cần internet). Chỉ cần internet khi `npm install` lần đầu.
682
+
683
+ **Q: Tôi có thể tùy chỉnh config không?**
684
+
685
+ A: Có! Chỉnh sửa file `_bmad-odoo/bmm/config.yaml` để thay đổi output folder, Odoo version, và các settings khác.
686
+
687
+ ---
688
+
286
689
  ## Tài Liệu Tham Khảo
287
690
 
288
691
  ### Files Quan Trọng
289
692
 
290
693
  | File | Mô Tả |
291
694
  |------|-------|
292
- | `bmm/config.yaml` | Cấu hình chính |
293
- | `bmm/data/odoo-knowledge-base.md` | Kiến thức Odoo |
294
- | `bmm/testarch/odoo-testing-guide.md` | Hướng dẫn test Odoo |
295
- | `_bmad-odoo-tieng-viet.md` | Tổng quan tiếng Việt |
695
+ | `_bmad-odoo/bmm/config.yaml` | Cấu hình chính |
696
+ | `_bmad-odoo/bmm/data/odoo-knowledge-base.md` | Kiến thức Odoo |
697
+ | `_bmad-odoo-output/` | Thư mục chứa artifacts |
698
+ | `.agent/workflows/` | Workflows cho Antigravity |
296
699
 
297
700
  ### Liên Kết
298
701
 
702
+ - [NPM Package](https://www.npmjs.com/package/bmad-odoo)
703
+ - [GitHub Repository](https://github.com/phamdungtk/bmad-odoo)
299
704
  - [BMAD Framework (gốc)](https://github.com/bmadcode/BMAD-METHOD)
300
705
  - [Odoo Documentation](https://www.odoo.com/documentation)
301
- - [OCA Guidelines](https://github.com/OCA/odoo-community.org/blob/master/website/Ede/code-guidelines.md)
706
+ - [OCA Guidelines](https://github.com/OCA/odoo-community.org)
302
707
 
303
708
  ---
304
709
 
305
710
  ## Hỗ Trợ
306
711
 
307
- Nếu bạn gặp vấn đề, hãy kiểm tra:
712
+ Nếu bạn gặp vấn đề:
308
713
 
309
- 1. **Config.yaml** - Đảm bảo cấu hình đúng
310
- 2. **Slash commands** - Sử dụng đúng lệnh kích hoạt agent
311
- 3. **Workflow steps** - Làm theo từng bước tuần tự
714
+ 1. **Kiểm tra cài đặt**: `npm list bmad-odoo`
715
+ 2. **Chạy lại setup**: `npx bmad-odoo-setup`
716
+ 3. **Xem Troubleshooting** trên
717
+ 4. **Report issue**: [GitHub Issues](https://github.com/phamdungtk/bmad-odoo/issues)
312
718
 
313
719
  ---
314
720
 
315
721
  **Phiên bản:** 1.0.0
316
722
  **Cập nhật:** 2026-01-02
317
- **Ngôn ngữ:** Tiếng Việt
723
+ **Ngôn ngữ:** Tiếng Việt
724
+ **License:** MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bmad-odoo",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "BMAD Framework mở rộng cho phát triển Odoo ERP - 10 AI Agents, 44+ Workflows, hỗ trợ tiếng Việt",
5
5
  "main": "index.js",
6
6
  "bin": {
@@ -44,5 +44,8 @@
44
44
  "README.md",
45
45
  "LICENSE",
46
46
  "CHANGELOG.md"
47
- ]
48
- }
47
+ ],
48
+ "dependencies": {
49
+ "bmad-odoo": "^1.0.0"
50
+ }
51
+ }
@@ -1,4 +1,4 @@
1
- #!/usr/bin/env node
1
+ #!/usr/bin/env node
2
2
 
3
3
  /**
4
4
  * BMAD-Odoo Setup CLI