0.1.3 • Published 2 years ago
yangtze-cli v0.1.3
yangtze-cli
为什么要使用 yangtze-cli?
🤩 项目交付,唯快不破 🎯
功能
快速上手搭建前端项目,提供多类项目模版,有效实现快速迭代、规范开发。 提供项目模版包括:
- 🖥️ PC 端项目模版(React/Umi/Typrscript)
- 📱 移动端项目模版(Vue/uni-app)
- (...不断更新中...)
如何使用
安装
$ npm i -g yangtze-cli
$ yangtze-cli -v
$ yarn global add yangtze-cli
$ yangtze-cli -v
创建项目
进入所需存放项目文件夹的目录,执行以下命令,将在该文件夹下建立命令行中所设项目名称的项目文件夹。
$ cd ~/location/of/project/folder
$ yangtze-cli create <project-name> [options] // 参数可选:-f 或 --force 强制创建
安装依赖
$ cd ~/location/of/project/folder/<project-name>
$ npm i
$ cd ~/location/of/project/folder/<project-name>
$ yarn
启动项目
web 端常用启动方法:
$ cd ~/location/of/project/folder/<project-name>
$ npm run start
$ cd ~/location/of/project/folder/<project-name>
$ yarn start
其他模版项目启动方式可参照项目模版文件夹下的 package.json 文件命令配置。
代码提交
模版下载完成后已自动初始化 git 仓库,首次提交代码需在配置 git 远程仓库后进行。
$ git remote add origin <git-url>
$ git add .
$ git commit -m "initial commit"
$ git push origin master
其他
- 查看帮助信息
$ yangtze-cli -h
- 所选模版项目的 开发规范、注意事项、目录结构 等参照对应模版项目说明。
持续开发
关于模版项目的持续开发,请注意如下规范:
- 模版项目集中放置于长江代码库统一项目目录下 (长江大数据代码库)
- 脚手架中供选择的模版名称即模版项目名称,用于自动配置模版下载地址,请勿随意修改
- 模版项目不同版本需拉取不同分支进行管理,分支名称即版本号,default 版本即默认最新版本( default 版本对应 master 分支),例:v1.0.0
- 保持项目 master 分支为最新版本
版本日志
版本号 | 更新日期 | 更新内容 |
---|---|---|
v0.1.2 | 2022-08-03 | 获取模版项目,快速构建前端项目代码 |
v0.1.3 | 2022-08-11 | 更新分组密钥 |
待更新功能
- 脚手架安全性优化