# 🌈 uni-app Vue3 Vite5 pinia2 TypeScript 基础框架
<p align="center">
<a href="https://cn.vuejs.org/" target="_blank">
<img src="https://img.shields.io/badge/-Vue3-34495e?logo=vue.js" />
</a>
<a href="https://pinia.vuejs.org/zh/" target="_blank">
<img src="https://img.shields.io/badge/-Vite5-646cff?logo=vite&logoColor=white" />
</a>
<a href="https://www.typescriptlang.org/zh/" target="_blank">
<img src="https://img.shields.io/badge/-TypeScript5-blue?logo=typescript&logoColor=white" />
</a>
<a href="https://eslint.org/" target="_blank">
<img src="https://img.shields.io/badge/-ESLint9-4b32c3?logo=eslint&logoColor=white" />
</a>
<a href="https://pnpm.io/" target="_blank">
<img src="https://img.shields.io/badge/-pnpm-F69220?logo=pnpm&logoColor=white" />
</a>
<a href="https://unocss.dev/" target="_blank">
<img src="https://img.shields.io/badge/-tailwindcss-0f172a?logo=tailwindcss" />
</a>
<a href="https://iconify.design/" target="_blank">
<img src="https://img.shields.io/badge/-Iconify-1769aa?logo=Iconify" />
</a>
<a href="https://gitee.com/h_mo/uniapp-vue3-vite-ts-template" target="_blank">
<img src="https://svg.hamm.cn/gitee.svg?type=star&user=h_mo&project=uniapp-vue3-vite-ts-template"/>
</a>
<a href="https://gitee.com/h_mo/uniapp-vue3-vite-ts-template" target="_blank">
<img src="https://svg.hamm.cn/gitee.svg?type=fork&user=h_mo&project=uniapp-vue3-vite-ts-template"/>
</a>
<a href="https://ext.dcloud.net.cn/plugin?id=8559" target="_blank">
<img src="https://svg.hamm.cn/badge.svg?key=Platform&value=uni-app"/>
</a>
</p>
## 简介
- **uni-app Vue3 Vite5 pinia2 TypeScript 基础框架**
- cli 创建的 Vue3/Vite 项目 与 使用 HBuilderX 导入插件 的包有差异,请直接访问 [开源地址](https://gitee.com/h_mo/uniapp-vue3-vite-ts-template)
- 访问[uniapp 插件](https://ext.dcloud.net.cn/plugin?id=8559)
- 如有问题请加群【[872378674](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=T3PX4_sWeMXeFGWF6EZJLXABSNyStYR0&authKey=EYXATTrGpmyowFxk9xtX6T7FIRbOF7brLd9uODxl%2B6jIbGfWQGW869V1hkPSlGYT&noverify=0&group_code=872378674)】交流
### 说明
- 框架完全基于 Vue3 SFC `<script setup>` 写法,不支持 Vue2;
- 可用于学习与交流;
- 目前测试: H5、APP(Android)、微信|支付宝|抖音小程序通过;
- 如发现问题或建议可在评论区留言, 或提[Issues](https://gitee.com/h_mo/uniapp-vue3-vite-ts-template/issues)及[PR](https://gitee.com/h_mo/uniapp-vue3-vite-ts-template/pulls),会及时处理;
- 如有需求亦可在评论区留言,或在此项目基础上增加;
## 特性
- **最新技术栈**：使用 Vue3/Vite5/pinia ,TypeScript 等前端前沿技术开发;
- **[Tailwindcss](https://tailwindcss.com/)**: 原子化 CSS, [iconify](https://iconify.design/)图标
- **Eslint**: 规范代码格式,统一编码;
- **路由拦截**: [uni-mini-router](https://gitee.com/fant-mini/uni-mini-router),类似Vue Router的API和功能,在uni-app中进行路由跳转、传参、拦截等常用操作;
- **请求拦截**: 使用[alova 请求](https://github.com/alovajs/alova),支持请求和响应拦截等;
- **Mock 数据**: 配合 alova 请求的[@alova/mock](https://github.com/alovajs/mock)，模拟 api 请求(App 不支持);
- **缓存加密**: 支持 AES 加密缓存,可设置区分在开发或生成环境中是否加密;
## 目录结构
```shell
.
├─ src
│ ├─assets # 静态资源目录
│ │
│ ├─env # 环境配置文件
│ │ ├─ .env
│ │ └─...
│ │
│ ├─components # 组件目录
│ │ ├─ BasicButton
│ │ │ ├─index.vue
│ │ │ └─prpos.ts
│ │ └─...
│ │
│ ├─enums # 枚举/常量
│ │ ├─ cacheEnum.ts
│ │ └─...
│ │
│ ├─pages # 页面
│ │ ├─ index
│ │ │ └─index.vue
│ │ └─...
│ │
│ ├─services # 接口相关
│ │ ├─ api # api
│ │ │ ├─auth.ts
│ │ │ └─...
│ │ │
│ │ └─ model # 数据模型
│ │ ├─authModel.d.ts
│ │ └─...
│ │
│ ├─settings # 设置
│ │ └─ encryptionSetting # 加密设置
│ │
│ ├─state # 状态管理模式(pinia)
│ │ ├─ modules # 数据模块
│ │ │ ├─auth.ts
│ │ │ └─...
│ │ │
│ │ └─ index.ts
│ │
│ ├─static # 静态公共文件
│ │ ├─ images # 图片
│ │ │ ├─avatar.png
│ │ │ └─...
│ │ │
│ │ └─ ...
│ │
│ ├─types # 类型文件
│ │ ├─ http.d.ts
│ │ └─ ...
│ │
│ └─utils # 工具类
│ ├─ cache # 缓存相关目录
│ ├─ http # request相关目录
│ ├─ interceptors # 拦截器相关目录
│ └─ ...
│
├─ .eslint.config.js
├─ .gitignore
├─ .npmrc
├─ favicon.ico
├─ index.html
├─ package.json
├─ pnpm-lock.yaml
├─ README.md
├─ tailwind.config.js
├─ tsconfig.json
└─ vite.config.ts
```
## 预览
- 域名到期，暂时已不能预览
[//]: # '- H5'
[//]: # ' '
[//]: # '- 小程序(体验版-需申请体验)'
[//]: #
[//]: # ' '
## 安装使用
- 安装依赖
> 若 pnpm 安装或运行失败，请使用 npm 或 yarn 安装依赖
```bash
pnpm install
```
- 运行
```bash
# 其他端请查看 package.json script
pnpm dev:h5
```
- 打包
```bash
# 其他端请查看 package.json script
pnpm build:h5
```
- 更新依赖到最新（新手请忽略）
```bash
pnpm up
# 打开HBuilder X alpha桌面程序-->点击上面的帮助-->历次更新说明-->获取最新版本号（如：3.7.2.20230217-alpha）
npx @dcloudio/uvm 3.7.2.20230217-alpha
```
## Gitee 参与贡献
1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request
## [Gitee 贡献提交规范](https://www.conventionalcommits.org/zh-hans/v1.0.0/)
### 提交类型
| 提交类型 | 标题 | 描述 |
| ---------- | ------------------ | ------------------------------------------------------------------------------------- |
| `feat` | 特征 | 新功能、新特性 |
| `fix` | Bug 修复 | bug 修复 |
| `docs` | 文档 | 仅文档更改 |
| `style` | 风格 | 不影响代码含义的更改（空格、格式、缺少分号等） |
| `refactor` | 代码重构 | 重构，在不影响代码内部行为，功能下的代码修改 |
| `perf` | 性能改进 | 更改代码，以提高性能 |
| `test` | 测试 | 添加缺失的测试或纠正现有的测试 |
| `build` | 构建 | 影响构建系统或外部依赖项的更改（示例范围：gulp、broccoli、npm） |
| `ci` | 持续集成 | 对我们的 CI 配置文件和脚本的更改（示例范围：Travis、Circle、BrowserStack、SauceLabs） |
| `chore` | 其他文件修改 | 不修改 src 或测试文件的其他更改 |
| `revert` | 还原 | 恢复之前的提交 |
| `release` | 发布新版本 | \- |
| `workflow` | 工作流相关文件修改 | \- |
### 提交别名
| 提交类型 | 映射到 | 标题 | 描述 |
| ------------------ | ------- | -------- | -------------------------- |
| `initial` | `feat` | 最初的 | 初始提交 |
| `dependencies` | `fix` | 依赖项 | 更新依赖项 |
| `peerDependencies` | `fix` | 对等依赖 | 更新对等依赖项 |
| `devDependencies` | `chore` | 开发依赖 | 更新开发依赖 |
| `metadata` | `fix` | 元数据 | 更新元数据（package.json） |
### 快捷别名提示
1. resolve a conflict：解决冲突
2. merge branch：合并分支
3. feat: [...] : 添加的新功能说明
4. fix: [...] : 修复的 bug 说明
5. initial project：初始化项目
6. style: [...] : 修改的样式范围
7. perf：[...] : 优化的范围
8. release : 发布新版本
9. docs: 文档修改
10. refactor： 代码重构
11. revert： 还原之前的版本
12. dependencies： 依赖项修改
13. devDependencies： 开发依赖修改
14. review：复习，回顾
15. strengthen: 加强，巩固