🌱 基于 Vue3 全家桶、TS/JS、Vite 构建工具，开箱即用的移动端项目基础模板
- ⚡ Vue3 + Vite5
- 🍕 TypeScript
- ✨ Vant4 组件库
- 🌀 Tailwindcss 原子类框架
- 👏 集成多种图标方案
- 🍍 Pinia 状态管理
- 🌓 支持深色模式
- 🧀 支持 i18n
- Vue-router 4
- vmin 视口适配
- Axios 封装
- 打包资源 gzip 压缩
- 开发环境支持 Mock 数据
- ESLint
- 首屏加载动画
- 开发环境调试面板
- 生产环境 CDN 依赖
如有 i18n 国际化多语言需求，请切换到 i18n 分支
主分支默认 TypeScript，如果你希望使用的是 JavaScript 语言，请切换 js-version 分支进行开发
👓 点击这里（PC浏览器请切换手机端模式）
注意：要求 Node 版本 18+，可使用 nvm 进行本地 Node 版本管理，同时建议使用 pnpm 包管理器。
# 克隆项目
git clone https://github.com/yulimchen/vue3-h5-template.git
# 进入项目目录
cd vue3-h5-template
# 安装依赖
pnpm install
# 启动服务
pnpm devi18n 国际化多语言版本 clone 方式
# 克隆项目
git clone -b i18n https://github.com/yulimchen/vue3-h5-template.git
# 同上进入目录&安装依赖等
cd vue3-h5-template如果你需要的是基于 JavaScript 构建的 H5 项目模板，可切换到 js-version 分支进行开发
# 克隆项目
git clone -b js-version https://github.com/yulimchen/vue3-h5-template.git
# 同上进入目录&安装依赖等
cd vue3-h5-template全量引入组件库太过臃肿，项目中使用 unplugin-vue-components 插件进行按需自动引入组件，可通过官方文档了解更多。
① Iconify 图标（推荐）
Iconify 拥有图标数量超过 20 万的图标库，同时文档比较友好，本项目基于 Iconify for Vue 稍微进行了封装。
使用方法 ⑴：
基于 Iconify 图标集网站获取到你想要的图标名称后填入 i-icon 组件的 icon 属性即可。
<i-icon icon="fa6-solid:heart" />配合 VS Code 编辑器扩展可在编码时实时预览图标！
注意，方法 ⑴ 是通过 Iconify API 按需请求获取图标，如果你的项目仅在内网环境部署，可通过👇🏻方法 ⑵ 离线使用图标。
使用方法 ⑵ ：
基于 Iconify 图标集网站搜索到你想要的图标，安装图标对应的图标集依赖包。
pnpm i -D @iconify-icons/fa6-solid依赖包名规则：@iconify-icons/[图标集]
引入你想要的图标 data，赋值给 i-icon 组件的 icon 属性即可。
图标路径规则：@iconify-icons/[图标集]/[图标名]
import Fa6SolidHeart from "@iconify-icons/fa6-solid/heart";<i-icon :icon="Fa6SolidHeart" />案例代码可参考本项目的 tools 页面，想对强大的 Iconify 了解更多？请戳 👉 https://iconify.design/docs/
② 本地 SVG 文件图标
- 将 svg 图标文件放在
src/icons/svg目录下- 在项目中直接使用
<svg-icon name="svg图标文件命名" />即可
例如：
本项目 src/icons/svg 中放了个叫 check-in.svg 的图标文件，然后在组件 name 属性中填入文件的命名即可，So easy~
<svg-icon name="check-in" />项目中使用了
unplugin-vue-components自动引入组件，所以main.ts中无需注册全局图标组件。
组件默认开启缓存，如某个组件需关闭缓存，在对应路由 meta 内的 noCache 字段赋值为 true 即可。
// src/router/routes.ts
const routes: Array<RouteRecordRaw> = [
// ...
{
path: "about",
name: "About",
component: () => import("@/views/about/index.vue"),
meta: {
title: "关于",
noCache: true
}
}
];为了保证页面能被正确缓存，请确保组件的 name 值和对应路由的 name 命名完全相同。
<!-- src/views/about/index.vue -->
<script setup lang="ts">
// Vue3.3+ defineOptions 宏
defineOptions({
name: "About"
});
</script>
<template>
<div>about</div>
</template>
为了方便移动端查看 log 信息和调试，开发环境引入了 eruda 调试面板的 cdn。如果你的开发环境不需要的话请在 .env.development 中修改值
# .env.development
# 开发环境启用 cdn eruda 调试工具。若不启用，将 true 修改为 false 或其他任意值即可
VITE_ENABLE_ERUDA = "true"在路由全局前置守卫中：
// src/router/index.ts
// ...
router.beforeEach((to: toRouteType, from, next) => {
// ...
// 页面 title
setPageTitle(to.meta.title);
next();
});具体实现方法见文件 src/utils/set-page-title.ts 。
本项目开发环境支持 mock 请求数据，在
mock目录中可配置接口和数据，具体见文档。
使用 cnjm-postcss-px-to-viewport 进行视口适配，相关配置见项目根目录下 postcss.config.js。
// postcss.config.js
module.exports = {
plugins: {
// 使用 cnjm-postcss-px-to-viewport 规避 postcss.plugin was deprecated 警告
"cnjm-postcss-px-to-viewport": {
viewportWidth: 375, // 根据设计稿设定
minPixelValue: 1, // 最小的转换数值
unitPrecision: 2 // 转化精度，转换后保留位数
},
autoprefixer: {
overrideBrowserslist: ["Android >= 4.0", "iOS >= 7"]
}
}
};Tailwindcss 从 3.0 版本开始默认使用 JIT 模式，打包代码不再臃肿，结合 vite 使用非常香~ 如果你还没使用过类似的框架，Tailwindcss 首页的示例非常直观。
官方文档：https://tailwindcss.com/docs/padding
项目使用 husky 规范 Git 提交信息，遵循社区主流的 Angular 规范。
feat 增加新功能
fix 修复问题/BUG
style 代码风格相关无影响运行结果的
perf 优化/性能提升
refactor 重构
revert 撤销修改
test 测试相关
docs 文档/注释
chore 依赖更新/脚手架配置修改等
workflow 工作流改进
ci 持续集成
types 类型定义文件更改
wip 开发中
// 格式
<type>(<scope>): <subject>
// 示例
feat(layout): 布局完成
本模板生产环境默认不开启 CDN 加载依赖，如需开启生产环境加载 CDN 依赖，在根目录生产环境变量文件 .env.production 中修改 VITE_CDN_DEPS 的值为 true 重新打包即可。
Font Awesome Solid 图标由 Dave Gandy 创作，基于 CC BY 4.0 许可发布。
