create-flutter
Version:
一个快速创建Flutter项目的脚手架工具,提供基础版和增强版两种模板
99 lines (69 loc) • 2.1 kB
Markdown
# Create Flutter
一个快速创建Flutter项目的脚手架工具,提供基础版和增强版两种模板,帮助开发者快速搭建Flutter项目结构。
## 功能特点
- **简单易用**:交互式命令行界面,轻松创建项目
- **多种模板**:
- **基础版**:提供Flutter项目的基础结构和常用配置
- **增强版**:在基础版基础上,集成了状态管理、网络请求封装等更多常用功能
- **项目类型**:支持创建应用(app)和模块(module)两种类型
- **自动配置**:自动生成项目结构,更新README文件
- **IDE集成**:自动在VS Code或Android Studio中打开新创建的项目
## 安装
### 方式一:使用npx(推荐)
无需安装,直接运行:
```bash
npx create-flutter
```
### 方式二:全局安装
```bash
# 全局安装
npm install -g create-flutter
# 使用命令
create-flutter
```
如果安装过程中遇到权限问题,可以尝试以下解决方案:
```bash
# Linux/macOS 用户可以使用 sudo
sudo npm install -g create-flutter
# 或者修改 npm 默认安装目录的权限
mkdir -p ~/.npm-global
npm config set prefix '~/.npm-global'
# 然后将以下行添加到 ~/.profile 或 ~/.bash_profile
export PATH=~/.npm-global/bin:$PATH
```
验证安装成功:
```bash
# 检查版本,确认安装成功
create-flutter --version
```
### 方式三:本地开发
```bash
# 克隆仓库
git clone https://github.com/username/create-flutter.git
cd create-flutter
# 安装依赖
npm install
# 运行
node bin/cli.js
```
## 使用步骤
1. 运行创建命令:`npx create-flutter`
2. 选择项目类型:应用(app)或模块(module)
3. 选择模板类型:基础版或增强版
4. 输入项目信息:
- 项目名称
- 包名
- 显示名称
- 项目存放路径
5. 等待创建完成
## 系统要求
- Node.js 10.0.0 或更高版本
- Python 3.8 或更高版本
- Flutter SDK 已安装并配置
## 参与贡献
1. Fork 本仓库
2. 新建分支:`git checkout -b feature/xxx`
3. 提交代码
4. 创建 Pull Request
## 许可证
[MIT](LICENSE)