aj-flutter-cli/README.md

a cli for creating flutter projects

> 注：使用 ` aj-flutter-cli` 创建 `flutter`项目之前，请确保你的本地已经安装了`flutter`的开发环境.
### 特性
  💡 快速生成项目模板    

  🔩 支持 `flutter` + `getx`(现已更新空安全)        

  🌟 错误提示       
 
  🔗 命令联想☁         


> flutter 现有更新至空安全，主要架构为`flutter v2.x + getx4.x`

### 模版仓库


<code>[flutter-getx-with-null-safety-template](https://github.com/Tom-Jack-Huang/aj-flutter-template.git)</code>

### 安装

 ```js
  yarn global add  aj-flutter-cli  ||  npm install -g  aj-flutter-cli
 ```

### 参数和命令 

```
Usage: ajFlutter <command> [options]

Options:
  -V, --version      output the version number
  -h, --help         output usage information

Commands:
  create <app-name>    Create a project with template from monia git repository.
  init <page-name>     Generate new flutter getx page from monia.
```


### 命令示例


- 生成`flutter getx` 新页面：

```shell
ajFlutter init detail
```

```
✨  Generate page in /Users/xieyezi/Desktop/flutter_demo/lib/pages/detail.
⠋ Generating, it's will not be wait long...
generate detail lib success.
generate /Users/xieyezi/Desktop/flutter_demo/lib/pages/detail/detail_view.dart success.
generate /Users/xieyezi/Desktop/flutter_demo/lib/pages/detail/detail_controller.dart success.
generate /Users/xieyezi/Desktop/flutter_demo/lib/pages/detail/detail_binding.dart success.

🎉  Successfully generate page detail.
```
> 注意：当你想生成一个新的`flutter` 新页面时，命名尽量采用`下划线`命名方式（虽然你输入`大驼峰`或者`小驼峰` `monia`也能正确处理，但是我们不建议你这样做）。


### 模版目录

#### flutter + getx

```
.
├── README.md
├── android
├── ios
├── lib
│   ├── common
│   ├── components
│   ├── config.dart
│   ├── env.dart
│   ├── global.dart
│   ├── main.dart
│   ├── pages
│   ├── router
│   ├── services
│   └── utils
├── pubspec.lock
├── pubspec.yaml
├── test
├── web
└── xsds.iml

```