此项目基于vue3
+uni-app
+ vite
搭建,适用于小程序开发 、 h5 开发,可以快速创建已经初具模型的模版。
相关文档地址
建议开发工具 vscode
pnpm 7.29.0、 yarn 1.22.19、npm 8.11.0 (推荐使用 pnpm) node v16
及以上(建议)
可以使用npm
\ cnpm
\ yarn
\ pnpm
等安装工具。
建议使用pnpm
pnpm i
.
┌─components 符合vue组件规范的uni-app组件目录
│ └─Footer 可复用的Footer组件
│ └─index.vue 组件嵌套可建文件夹嵌套,默认index
├─pages 业务页面文件存放的目录(小程序: 只存放主页及主包页面)
│ ├─index
│ │ └─index.vue index页面
│ └─list
│ └─index.vue list页面
├─packA 注意:小程序才进行分包业务(packA,packB A/B代表业务名称,目录可与主工程类似,可有自己的components,utils...)
│ ├─index
│ │ └─index.vue index页面
│ └─list
│ │ └─list.vue list页面
│ └─components
│ └─Footer 可复用的Footer组件
│ └─index.vue 组件嵌套可建文件夹嵌套,默认index
│
│
├─static 存放应用引用的本地静态资源的目录,注意:(由于小程序对资源200k大小有限制,所以该处只存放必须图标资源)
├─libs 引入第三方库文件
├─store 采用vuex进行数据缓存
├─locale 国际化配置(可选,如不需请删除该目录,去除i18n相关依赖)
│ ├─index.ts 公共配置
│ ├─zh-Hans.json 简体
│ ├─zh-Hant.json 繁体
│ └─en.json 英文
├─utils 公共工具目录
├─main.js Vue初始化入口文件
├─App.vue 应用配置,用来配置App全局样式以及监听 应用生命周期
├─pages.json 配置页面路由、导航条、选项卡等页面类信息,详见
├─manifest.json 项目配置文件(如:应用名称、appid、权限配置 ...)
├─.eslintignore eslint 忽略文件配置
├─.eslintrc eslint 规则配置
├─.gitignore git 上传忽略文件配置
├─.prettierignore prettier 规则效验忽略文件配置
├─commitlint.config.js 提交信息规范配置
├─prettier.config.js prettier 规则效验文件配置
└─uni.scss 这里是uni-app内置的常用样式变量
$$
├─static 在 src 目录同级有个 static 目录,该目录主要存放 cdn 文件,后部署服务端(该文件不参与打包编译。)
uni-app 提供了多种环境的启动方式,可以根据package.json
的script
字段,来选择执行
比如编译微信小程序的方式
pnpm run dev:mp-weixin
打包后可运用到生产环境,可根据package.json
中的 script
字段,
- eslint 代码验证,以及保存自动修复
- git-commit 代码提交前验代码格式 ßßß
- request 函数的封装及加密解密
- 全局状态管理
git commit 的 message 做了格式验证,请参照以下的格式进行提交
git commit -m 'feat: 我增加了一个功能'
git commit -m 'fix: 修复了某个bug'
git commit -m 'docs: 文档变更'
git commit -m 'style: 样式变更'
我们非常欢迎你的贡献,你可以通过以下方式和我们一起共建基线框架:
- 联系维护人员。匡威865509949@qq.com