Skip to content

yuadh/yuadh-fecli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

yaudh-fecli 是一个前端应用模板脚手架工具。其配置了前端开发的常用工具库如:ElementUI组件库、Vuex状态管理、VueRouter官方路由、Axios网络请求库、Eslint+Prettier等代码规范和Commit提交工具等等....大大减少了前端应用的配置初始化时间。 可选模板为adminwebmobileminiapp

  • admin : 中后台项目 —— 较少的交互和样式,注重中后台业务相关功能偏向业务用户
  • web: 应用型项目 —— 对UI和交互有较高要求,注重用户的体验和功能偏向普通用户
  • mobile: 移动端项目 —— 对集成移动端适配较高要求的,计划flutter、react native创建模板
  • miniapp:小程序项目 —— 应用于各类小程序的需求场景,计划uniapp、trao、原生创建模板

快速开始

⭐环境要求

  • Node 版本 > 18.0.0
  • yarn/pnpm 包管理工具,非必须

因为是前端项目脚手架工具, 而使用 JavaScript 编写的脚本程序
前端启动必需安装 Node,所以不使用 shell脚本编写
quick-start:输入以下命令即可开始配置你的前端应用程序

npx yuadh-fecli create

初次使用,会提示需要安装相关依赖。回车即可
image.png
按照提示信息创建你的应用配置信息:
image.png
正常情况下, 环境和配置无误的情况下就正常生成了你的应用程序
只需要和一般的前端项目一样安装依赖,启动项目即可

npm install #安装依赖
npm run dev #启动项目
#### 强烈推荐使用 yarn/pnpm 包管理工具
yarn #安装依赖    
yarn dev #启动项目

更多用法

可以使用带参形式减少配置步骤
使用方式:npx yuadh-fecli [options]
参数说明:

  • -a/--app-name 项目应用名称,可选
  • -t/--template 项目应用模板[admin/web/mobile/miniapp],可选
  • -h/--help 脚手架帮助文档,该参数为单独携带使用
  • -v/--version 脚手架版本信息,该参数为单独携带使用

使用示例:npx yuadh-fecli -a my-admin-app -t admin

迭代计划

  • 更加规范模板的代码风格:Eslint+Prettier+stylelint
  • 更加规范模板仓库git的Commit提交:Husky+Lint-Staged + Commitlint + Commitizen
  • 添加 webmobileminiapp等更多模板
  • 接入 dockergitlab-CI/CD多环境、云原生等....
  • 学习接入更多优秀的脚手架工具模块等...

开源地址

About

前端应用脚手架CLI@yuadh

Resources

Stars

Watchers

Forks

Packages

No packages published