@oss-x/fgen-cli
v1.0.1
Published
Flutter project generator CLI - Tạo cấu trúc dự án Flutter chuẩn theo kiến trúc Clean Architecture + Feature-First, tối ưu cho tất cả nền tảng.
Maintainers
Readme
@oss-x/fgen-cli ⚡
Flutter Project Generator CLI — Tạo cấu trúc dự án Flutter chuẩn theo kiến trúc Clean Architecture + Feature-First
✨ Tính năng
- 🏗️ Clean Architecture — Cấu trúc theo 3 tầng: Data, Domain, Presentation
- 📁 Feature-First — Tổ chức theo tính năng, dễ mở rộng
- 🌐 Multi-Platform — Tối ưu cho Mobile, Desktop, và Web
- 📦 State Management — Hỗ trợ BLoC, Riverpod, và GetX
- 🎨 Design System — Theme, Typography, Spacing sẵn sàng
- 📚 Documentation — Tự động tạo ARCHITECTURE.md, STRUCTURE.md
- 🌍 Đa ngôn ngữ — Hỗ trợ l10n sẵn (EN + VI)
- 🧪 Test-Ready — Cấu trúc test sẵn sàng
🚀 Cài đặt
# Cài đặt toàn cục
npm install -g @oss-x/fgen-cli
# Hoặc sử dụng trực tiếp với npx
npx @oss-x/fgen-cli create my_app📖 Sử dụng
Tạo dự án mới
# Interactive mode (khuyến nghị)
fgen create my_app
# Non-interactive mode
fgen create my_app --state-management bloc --org com.example --no-interactiveThêm feature mới
# Trong thư mục dự án Flutter
fgen add-feature payment
fgen add-feature chat --state-management riverpodKiểm tra môi trường
fgen doctor⚙️ Tùy chọn
fgen create [project-name]
| Option | Mô tả | Mặc định |
|--------|--------|----------|
| -s, --state-management <type> | bloc, riverpod, hoặc getx | bloc |
| -o, --org <org> | Organization (com.example) | com.example |
| -p, --platforms <type> | all, mobile, desktop, web | all |
| --no-l10n | Tắt đa ngôn ngữ | false |
| --no-example | Không tạo feature mẫu | false |
| --no-interactive | Chạy không tương tác | false |
fgen add-feature <feature-name>
| Option | Mô tả | Mặc định |
|--------|--------|----------|
| -s, --state-management <type> | bloc, riverpod, hoặc getx | (hỏi) |
📁 Cấu trúc được tạo ra
my_app/
├── lib/
│ ├── main.dart
│ ├── bootstrap.dart
│ ├── app/
│ │ ├── app.dart
│ │ ├── router/
│ │ ├── theme/
│ │ └── di/
│ ├── core/
│ │ ├── constants/
│ │ ├── errors/
│ │ ├── network/
│ │ ├── usecase/
│ │ ├── utils/
│ │ ├── extensions/
│ │ └── widgets/
│ ├── features/
│ │ ├── home/
│ │ ├── auth/
│ │ ├── splash/
│ │ └── ...
│ └── l10n/
├── test/
├── integration_test/
├── assets/
├── ARCHITECTURE.md
├── STRUCTURE.md
└── CONTRIBUTING.md🤝 Đóng góp
Xem CONTRIBUTING.md.
📄 Giấy phép
MIT License - xem file LICENSE.
