更新记录
0.0.1(2025-06-30) 下载此版本
0.0.1
- 首次发布,支持快速构建微信小程序、H5、App(iOS/Android) 等多端应用。
- 包含了前端工程化常用能力与Vue3生态相关的能力
平台兼容性
uni-app(4.61)
Vue2 | Vue3 | Chrome | Safari | app-vue | app-nvue | Android | iOS | 鸿蒙 |
---|---|---|---|---|---|---|---|---|
× | √ | √ | √ | √ | × | 8.0 | 12 | √ |
微信小程序 | 支付宝小程序 | 抖音小程序 | 百度小程序 | 快手小程序 | 京东小程序 | 鸿蒙元服务 | QQ小程序 | 飞书小程序 | 快应用-华为 | 快应用-联盟 |
---|---|---|---|---|---|---|---|---|---|---|
√ | - | - | - | - | - | - | - | - | - | - |
其他
多语言 | 暗黑模式 | 宽屏模式 |
---|---|---|
√ | √ | √ |
项目简介
基于 uni-app 的 Vue3 + TypeScript 快速开发模板,集成 sard-uniapp-ui、Vite、luch-request、Pinia 及 ESLint,旨在为跨平台应用开发提供高效、规范的基础环境,支持快速构建微信小程序、H5、App 等多端应用。
项目特点
- 技术栈前沿:采用 Vue3 响应式系统,结合 Vite 高效构建工具,提升开发体验。
- 状态管理:集成 Pinia,提供更简洁、可扩展的状态管理方案。
- UI 组件库:内置 sard-uniapp 组件库,90+个高质量组件覆盖移动端主流场景,支持按需引入、Tree Shaking及多端兼容(H5/小程序/App),减少重复开发。
- 代码规范:配置 ESLint 代码检查,统一团队编码规 & 格式化代码,提升代码质量与可读性。
- 跨平台支持:基于 uni-app,一次开发可发布到微信小程序、H5、APP 等多个平台。
- 内置样式:提供flex布局等快捷类名,无需额外引入样式文件,快速实现页面布局。
- 类型系统:全面采用 TypeScript 开发,提供完整类型定义,增强代码健壮性和开发体验。
目录结构
├── .husky/ # Git钩子配置
│ ├── _/
│ ├── commit-msg # 提交信息校验钩子
│ └── pre-commit # 提交前检查钩子
├── src/ # 主源码目录
│ ├── App.vue # 应用根组件
│ ├── androidPrivacy.json # Android隐私协议
│ ├── api/ # API 接口封装
│ ├── config.ts # 项目配置文件
│ ├── env.d.ts # 环境类型声明
│ ├── main.ts # 应用入口文件
│ ├── manifest.json # 应用配置(如小程序 AppID)
│ ├── mixin/ # 全局混入
│ ├── pages/ # 页面文件
│ ├── pages.json # 页面路由及全局配置
│ ├── shime-uni.d.ts # uni-app类型声明
│ ├── static/ # 静态资源(图片、CSS)
│ ├── stores/ # Pinia 状态管理
│ ├── types/ # 类型声明
│ ├── uni.scss # 全局 SCSS 样式
│ ├── uni_modules/ # uni-app 模块
│ └── utils/ # 工具函数库
│ ├── common/ # 通用工具
│ ├── app.ts # App相关工具
│ ├── h5.ts # H5相关工具
│ ├── request.ts # 请求封装
│ └── weixin.ts # 微信小程序工具
├── .eslintignore # ESLint 忽略文件配置
├── .eslintrc-auto-import.json # 自动导入ESLint配置
├── .eslintrc.js # ESLint 规则配置
├── .gitignore # Git 忽略文件配置
├── LICENSE # 项目许可证
├── README.md # 项目说明文档
├── commitlint.config.js # Git提交规范配置
├── index.html # 入口 HTML 文件
├── package.json # 项目依赖及脚本配置
├── shims-uni.d.ts # uni-app 类型声明
├── tsconfig.json # TypeScript 配置文件
└── vite.config.ts # Vite 构建配置
技术栈
- 框架:Vue3、uni-app
- 状态管理:Pinia
- 构建工具:Vite
- 请求库:luch-request
- UI 组件库:sard-uniapp(官方文档)
- 代码规范:ESLint
- 类型系统:全面采用 TypeScript 开发,提供完整类型定义,增强代码健壮性和开发体验。
使用教程
环境准备
依赖安装
pnpm install
运行开发
- 微信小程序:
pnpm run dev:mp-weixin
- H5:
pnpm run dev:h5
- 其他平台:参考 uni-app 文档调整命令(如
dev:app
运行 App)
构建发布
- 微信小程序:
pnpm run build:mp-weixin
- H5:
pnpm run build:h5
功能模块说明
- API 封装:
src/api/
目录提供通用接口请求封装,支持统一处理请求头、错误提示等。 - 状态管理:
src/store/
目录使用 Pinia 管理全局状态(如用户信息、应用配置)。 - 工具函数:
src/utils/
包含常用工具(如请求封装、数据校验、日期格式化)。 - 权限管理(App Android):
src/utils/app.ts
封装了Android平台权限监听与申请功能,解决上架华为应用市场审核要求 - 数据快捷验证工具:
src/utils/common/validate.ts
提供多种验证函数(如uni.$tao.validate.mobile('***')
校验手机号),覆盖常见业务场景的数据格式校验需求。 - 全局样式:
src/uni.scss
定义全局 SCSS 变量及混合,保持样式一致性。 - 页面路由:
pages.json
配置页面路径及导航栏样式,支持动态路由。
Git提交规范
项目采用Conventional Commits规范,提交流程如下:
- 添加修改文件到暂存区:
git add .
- 运行交互式提交命令(选择提交类型和填写提交信息):
pnpm cm
- 推送代码到远程仓库:
git push
提交信息格式要求:
<type>[optional scope]: <description>
[optional body]
[optional footer]
常用type类型:
- feat: 新功能
- fix: 修复bug
- docs: 文档变更
- style: 代码格式调整
- refactor: 代码重构
- perf: 性能优化
- test: 测试相关
- build: 对构建过程或构建依赖的变更
- ci: 持续集成(CI)相关配置文件或脚本的变更
- chore: 构建过程或辅助工具的变动
- revert: 恢复之前的提交
示例:
feat(login): 添加用户登录功能
添加了基于JWT的用户登录验证功能
Closes #123
其他
- 随机图片地址(推荐使用第一个地址,加载更快):
- https://loremflickr.com/160/160
- https://picsum.photos/200/200
- uniapp-vue3-js-vite-pinia-eslint 快速开发模板