create-flutter
Version:
一个快速创建Flutter项目的脚手架工具,提供基础版和增强版两种模板
76 lines (54 loc) • 1.89 kB
Markdown
# Create Flutter
A scaffolding tool for quickly creating Flutter projects, offering both basic and enhanced templates to help developers rapidly set up Flutter project structures.
## Features
- **Easy to Use**: Interactive command-line interface for effortless project creation
- **Multiple Templates**:
- **Basic Version**: Provides the basic structure and common configurations for Flutter projects
- **Enhanced Version**: Builds on the basic version, integrating state management, network request encapsulation, and more common functionalities
- **Project Types**: Supports creating both applications (app) and modules (module)
- **Automatic Configuration**: Automatically generates project structure and updates README files
- **IDE Integration**: Automatically opens newly created projects in VS Code or Android Studio
## Installation
### Option 1: Using npx (Recommended)
No installation required, just run:
```bash
npx create-flutter
```
### Option 2: Global Installation
```bash
# Global installation
npm install -g create-flutter
# Use command
create-flutter
```
### Option 3: Local Development
```bash
# Clone repository
git clone https://github.com/username/create-flutter.git
cd create-flutter
# Install dependencies
npm install
# Run
node bin/cli.js
```
## Usage Steps
1. Run the creation command: `npx create-flutter`
2. Select project type: application (app) or module (module)
3. Select template type: basic or enhanced version
4. Enter project information:
- Project name
- Package name
- Display name
- Project storage path
5. Wait for creation to complete
## System Requirements
- Node.js 10.0.0 or higher
- Python 3.8 or higher
- Flutter SDK installed and configured
## Contributing
1. Fork this repository
2. Create a new branch: `git checkout -b feature/xxx`
3. Submit your code
4. Create a Pull Request
## License
[MIT](LICENSE)