242 lines
13 KiB
Markdown
242 lines
13 KiB
Markdown
<div id="top" align="center">
|
||
|
||
<img src="https://cdn.jsdelivr.net/gh/vue-zone/static/cover.png" alt="cover" />
|
||
|
||
<h1 align="center">vue3-vant-mobile</h1>
|
||
|
||
[English](./README.md) / 简体中文
|
||
|
||
An mobile web apps template based on the Vue 3 ecosystem.
|
||
|
||
一个基于 Vue 3 生态系统的移动 web 应用模板，帮助你快速完成业务开发。
|
||
|
||
<p>
|
||
<img src="https://img.shields.io/github/license/vue-zone/vue3-vant-mobile" alt="license" />
|
||
<img src="https://img.shields.io/github/package-json/v/vue-zone/vue3-vant-mobile" alt="version" />
|
||
<img src="https://img.shields.io/github/repo-size/vue-zone/vue3-vant-mobile" alt="repo-size" />
|
||
<img src="https://img.shields.io/github/languages/top/vue-zone/vue3-vant-mobile" alt="languages" />
|
||
<img src="https://img.shields.io/github/issues-closed/vue-zone/vue3-vant-mobile" alt="issues" />
|
||
</p>
|
||
|
||
[🌐预览](https://vue3-vant-mobile.netlify.app) / [📖文档](https://vue-zone.github.io/docs/vue3-vant-mobile/) / [🗨️交流](https://github.com/vue-zone/vue3-vant-mobile/issues/56) / [📝反馈](https://github.com/vue-zone/vue3-vant-mobile/issues)
|
||
|
||
[](https://deepwiki.com/vue-zone/vue3-vant-mobile) [](https://app.netlify.com/sites/vue3-vant-mobile/deploys)
|
||
|
||
</div>
|
||
|
||
<br>
|
||
|
||
## Features
|
||
|
||
- ⚡️ [Vue 3](https://github.com/vuejs/core), [Vite 7](https://github.com/vitejs/vite), [pnpm](https://pnpm.io/), [esbuild](https://github.com/evanw/esbuild) - 就是快！
|
||
|
||
- 🗂 [基于文件的路由](./src/router)
|
||
|
||
- 📦 [组件自动化加载](./src/components)
|
||
|
||
- 🍍 [使用 Pinia 的状态管理](https://pinia.vuejs.org)
|
||
|
||
- 📲 [PWA](https://github.com/antfu/vite-plugin-pwa)
|
||
|
||
- 🎨 [UnoCSS](https://github.com/antfu/unocss) - 高性能且极具灵活性的即时原子化 CSS 引擎
|
||
|
||
- 🌍 [I18n 国际化开箱即用](./src/locales)
|
||
|
||
- 🔥 使用 [新的 `<script setup>` 语法](https://github.com/vuejs/rfcs/pull/227)
|
||
|
||
- 📥 [API 自动加载](https://github.com/antfu/unplugin-auto-import) - 直接使用 Composition API 无需引入
|
||
|
||
- 💪 TypeScript, 当然
|
||
|
||
- 💾 [本地数据模拟](https://github.com/pengzhanbo/vite-plugin-mock-dev-server)的支持
|
||
|
||
- 🌈 Git hooks - 提交代码 eslint 检测 和 提交规范检测
|
||
|
||
- 🪶 [Vant](https://github.com/youzan/vant) - 移动端 Vue 组件库
|
||
|
||
- 🔭 [vConsole](https://github.com/vadxq/vite-plugin-vconsole) - 移动端网页开发工具
|
||
|
||
- 📱 浏览器适配 - 使用 viewport vw/vh 单位布局
|
||
|
||
- 💻 [桌面端优化](https://github.com/wswmsword/postcss-mobile-forever) - 处理为移动端视图
|
||
|
||
- 🌓 支持深色模式
|
||
|
||
- 🛡️ 将 [ESM](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) 设为默认
|
||
|
||
- ☁️ 零配置部署 [Netlify](https://www.netlify.com)
|
||
|
||
<br>
|
||
|
||
## 预配置
|
||
|
||
### UI 框架
|
||
|
||
- [UnoCSS](https://github.com/antfu/unocss) - 高性能且极具灵活性的即时原子化 CSS 引擎
|
||
- [Vant](https://github.com/youzan/vant) - 移动端 Vue 组件库
|
||
- [`vant-touch-emulator`](https://github.com/youzan/vant/tree/main/packages/vant-touch-emulator) - 在桌面端上模拟移动端 touch 事件
|
||
- [`vant-use`](https://github.com/youzan/vant/tree/main/packages/vant-use) - Vant 内置的组合式 API
|
||
|
||
### 插件
|
||
|
||
- [Vue Router](https://github.com/vuejs/router)
|
||
- [`unplugin-vue-router`](https://github.com/posva/unplugin-vue-router) - 以文件系统为基础的路由
|
||
- [Pinia](https://pinia.vuejs.org) - 直接的, 类型安全的, 使用 Composition API 的轻便灵活的 Vue 状态管理库
|
||
- [`pinia-plugin-persistedstate`](https://github.com/prazdevs/pinia-plugin-persistedstate) - 适用于 Pinia 的持久化存储插件
|
||
- [Vue I18n](https://github.com/intlify/vue-i18n-next) - 国际化
|
||
- [`unplugin-vue-i18n`](https://github.com/intlify/bundle-tools/tree/main/packages/unplugin-vue-i18n) - Vue I18n 的 Vite 插件
|
||
- [unplugin-vue-components](https://github.com/antfu/unplugin-vue-components) - 自动加载组件
|
||
- [unplugin-auto-import](https://github.com/antfu/unplugin-auto-import) - 直接使用 Composition API 等，无需导入
|
||
- [vite-plugin-vconsole](https://github.com/vadxq/vite-plugin-vconsole) - vConsole 的 vite 插件
|
||
- [vite-plugin-mock-dev-server](https://github.com/pengzhanbo/vite-plugin-mock-dev-server) - vite mock 开发服务（mock-dev-server）插件
|
||
- [postcss-mobile-forever](https://github.com/wswmsword/postcss-mobile-forever) - 一款 PostCSS 插件，将固定尺寸的移动端视图转为具有最大宽度的可伸缩的移动端视图
|
||
- [vite-plugin-vue-devtools](https://github.com/vuejs/devtools-next) - 旨在增强Vue开发者体验的Vite插件
|
||
- [vueuse](https://github.com/antfu/vueuse) - 实用的 Composition API 工具合集
|
||
- [@unhead/vue v2](https://github.com/unjs/unhead) - 响应式地操作文档头信息
|
||
- [vite-plugin-pwa](https://github.com/antfu/vite-plugin-pwa) - PWA
|
||
- [vite-plugin-sitemap](https://github.com/jbaubree/vite-plugin-sitemap) - sitemap 和 robots 生成器
|
||
|
||
### 编码风格
|
||
|
||
- 使用 Composition API 地 [`<script setup>` SFC 语法](https://github.com/vuejs/rfcs/pull/227)
|
||
- [ESLint](https://eslint.org/) 配置为 [@antfu/eslint-config](https://github.com/antfu/eslint-config), 单引号, 无分号
|
||
|
||
### 开发工具
|
||
|
||
- [TypeScript](https://www.typescriptlang.org/)
|
||
- [pnpm](https://pnpm.js.org/) - 快, 节省磁盘空间的包管理器
|
||
- [Netlify](https://www.netlify.com/) - 零配置的部署
|
||
- [VS Code Extensions](./.vscode/extensions.json)
|
||
- [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) - Vue 3 `<script setup>` IDE 支持
|
||
- [Unocss](https://marketplace.visualstudio.com/items?itemName=antfu.unocss) - Unocss 智能提示
|
||
- [Goto Alias](https://marketplace.visualstudio.com/items?itemName=antfu.goto-alias) - 跳转到定义
|
||
- [Iconify IntelliSense](https://marketplace.visualstudio.com/items?itemName=antfu.iconify) - 图标内联显示和自动补全
|
||
- [File Nesting](https://marketplace.visualstudio.com/items?itemName=antfu.file-nesting) - 文件嵌套
|
||
- [i18n Ally](https://marketplace.visualstudio.com/items?itemName=lokalise.i18n-ally) - 多合一的 I18n 支持
|
||
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) - ESLint 支持
|
||
- [Better JSON5](https://marketplace.visualstudio.com/items?itemName=blueglassblock.better-json5) - JSON5 支持
|
||
|
||
## 现在可以试试
|
||
|
||
> vue3-vant-mobile 需要 Node 版本 20+
|
||
|
||
### GitHub 模板
|
||
|
||
[使用这个模板创建仓库](https://github.com/vue-zone/vue3-vant-mobile/generate)
|
||
|
||
### 克隆到本地
|
||
|
||
如果您更喜欢使用更干净的 git 历史记录手动执行此操作
|
||
|
||
```bash
|
||
npx tiged vue-zone/vue3-vant-mobile my-mobile-app
|
||
cd my-mobile-app
|
||
pnpm i # 如果你没装过 pnpm, 可以先运行: npm install -g pnpm
|
||
```
|
||
|
||
## 清单
|
||
|
||
使用此模板时，请尝试按照清单正确更新您自己的信息
|
||
|
||
- [ ] 在 `LICENSE` 中改变作者名
|
||
- [ ] 在 `index.html` 中改变标题
|
||
- [ ] 在 `vite.config.ts` 更改主机名
|
||
- [ ] 在 `public` 目录下改变favicon
|
||
- [ ] 整理 README 并删除路由
|
||
|
||
紧接着, 享受吧 :)
|
||
|
||
## 使用
|
||
|
||
### 开发
|
||
|
||
只需要执行以下命令就可以在 <http://localhost:3000> 中看到
|
||
|
||
```bash
|
||
pnpm dev
|
||
```
|
||
|
||
### 构建
|
||
|
||
构建该应用只需要执行以下命令
|
||
|
||
```bash
|
||
pnpm build
|
||
```
|
||
|
||
然后你会看到用于发布的 `dist` 文件夹被生成。
|
||
|
||
### 部署到 Netlify
|
||
|
||
前往 [Netlify](https://app.netlify.com/start) 并选择你的仓库, 一路 `OK` 下去，稍等一下后，你的应用将被创建。
|
||
|
||
## 社区 👏
|
||
|
||
我们推荐使用 [议题](https://github.com/vue-zone/vue3-vant-mobile/issues) 来反馈问题, 或者您也可以通过 [微信交流群](https://github.com/vue-zone/vue3-vant-mobile/issues/56) 联系我们。
|
||
|
||
## 捐赠 ☕
|
||
|
||
[请我喝一杯咖啡](https://github.com/cwandev/sponsor)
|
||
|
||
<h2 align="center">💝 我们的赞助者 💝</h2>
|
||
|
||
<p align="center">
|
||
您的赞助将帮助我们继续迭代这个令人兴奋的项目! 🚀
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="https://github.com/keyFeng"><img src="https://avatars.githubusercontent.com/u/52267976?v=4" width="60px" alt="keyFeng" /></a>
|
||
<a href="https://github.com/ljt990218"><img src="https://avatars.githubusercontent.com/u/50509815?v=4" width="60px" alt="ljt990218" /></a>
|
||
<a href="https://github.com/heked"><img src="https://avatars.githubusercontent.com/u/14127731?v=4" width="60px" alt="heked" /></a>
|
||
<a href="https://github.com/topcnm"><img src="https://avatars.githubusercontent.com/u/8057893?v=4" width="60px" alt="topcnm" /></a>
|
||
<a href="https://github.com/qiyue2015"><img src="https://avatars.githubusercontent.com/u/11554433?v=4" width="60px" alt="qiyue2015" /></a>
|
||
<a href="https://github.com/scc0"><img src="https://avatars.githubusercontent.com/u/45963033?v=4" width="60px" alt="scc0" /></a>
|
||
<a href="https://github.com/xiaminxi"><img src="https://avatars.githubusercontent.com/u/37994820?v=4" width="60px" alt="xiaminxi" /></a>
|
||
<a href="https://github.com/wangpeng00544"><img src="https://avatars.githubusercontent.com/u/54630102?v=4" width="60px" alt="wangpeng00544" /></a>
|
||
<a href="https://github.com/ljgx"><img src="https://avatars.githubusercontent.com/u/59424192?v=4" width="60px" alt="ljgx" /></a>
|
||
<a href="https://github.com/3026546679"><img src="https://avatars.githubusercontent.com/u/36257162?v=4" width="60px" alt="3026546679" /></a>
|
||
<a href="https://github.com/shuilong001"><img src="https://avatars.githubusercontent.com/u/219820297?v=4" width="60px" alt="shuilong001" /></a>
|
||
</p>
|
||
|
||
<h2 align="center">
|
||
💪 贡献者 💪
|
||
</h2>
|
||
|
||
<p align="center">
|
||
我们的贡献者使这个项目变得更好。谢谢你！ 🙏
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="https://github.com/cwandev"><img src="https://avatars.githubusercontent.com/u/22477554?v=4" width="60px" alt="cwandev" /></a>
|
||
<a href="https://github.com/ljt990218"><img src="https://avatars.githubusercontent.com/u/50509815?v=4" width="60px" alt="ljt990218" /></a>
|
||
<a href="https://github.com/wswmsword"><img src="https://avatars.githubusercontent.com/u/26893092?v=4" width="60px" alt="wswmsword" /></a>
|
||
<a href="https://github.com/weiq"><img src="https://avatars.githubusercontent.com/u/1697158?v=4" width="60px" alt="weiq" /></a>
|
||
<a href="https://github.com/SublimeCT"><img src="https://avatars.githubusercontent.com/u/20380890?v=4" width="60px" alt="SublimeCT" /></a>
|
||
<a href="https://github.com/ReginYuan"><img src="https://avatars.githubusercontent.com/u/49477488?v=4" width="60px" alt="ReginYuan" /></a>
|
||
<a href="https://github.com/smartsf"><img src="https://avatars.githubusercontent.com/u/19995400?v=4" width="60px" alt="smartsf" /></a>
|
||
<a href="https://github.com/Kysen777"><img src="https://avatars.githubusercontent.com/u/63892082?v=4" width="60px" alt="Kysen777" /></a>
|
||
<a href="https://github.com/Leezon"><img src="https://avatars.githubusercontent.com/u/38120280?v=4" width="60px" alt="Leezon" /></a>
|
||
<a href="https://github.com/AlphaYoung111"><img src="https://avatars.githubusercontent.com/u/54132313?v=4" width="60px" alt="AlphaYoung111" /></a>
|
||
<a href="https://github.com/leo4developer"><img src="https://avatars.githubusercontent.com/u/15160478?v=4" width="60px" alt="leo4developer" /></a>
|
||
<a href="https://github.com/InsHomePgup"><img src="https://avatars.githubusercontent.com/u/47906083?v=4" width="60px" alt="InsHomePgup" /></a>
|
||
<a href="https://github.com/wowping"><img src="https://avatars.githubusercontent.com/u/137802961?v=4" width="60px" alt="wowping" /></a>
|
||
<a href="https://github.com/ChunyuPCY"><img src="https://avatars.githubusercontent.com/u/21986942?v=4" width="60px" alt="ChunyuPCY" /></a>
|
||
<a href="https://github.com/qiyue2015"><img src="https://avatars.githubusercontent.com/u/11554433?v=4" width="60px" alt="qiyue2015" /></a>
|
||
<a href="https://github.com/pyQianYi"><img src="https://avatars.githubusercontent.com/u/57526688?v=4" width="60px" alt="pyQianYi" /></a>
|
||
<a href="https://github.com/xyy94813"><img src="https://avatars.githubusercontent.com/u/17971352?v=4" width="60px" alt="xyy94813" /></a>
|
||
<a href="https://github.com/faukwaa"><img src="https://avatars.githubusercontent.com/u/133618995?v=4" width="60px" alt="faukwaa" /></a>
|
||
<a href="https://github.com/chensongni"><img src="https://avatars.githubusercontent.com/u/18071921?v=4" width="60px" alt="chensongni" /></a>
|
||
<a href="https://github.com/csheng-github"><img src="https://avatars.githubusercontent.com/u/88492404?v=4" width="60px" alt="csheng-github" /></a>
|
||
<a href="https://github.com/LostElkByte"><img src="https://avatars.githubusercontent.com/u/24487727?v=4" width="60px" alt="LostElkByte" /></a>
|
||
<a href="https://github.com/xuxichen"><img src="https://avatars.githubusercontent.com/u/18108140?v=4" width="60px" alt="xuxichen" /></a>
|
||
<a href="https://github.com/1411430556"><img src="https://avatars.githubusercontent.com/u/67215517?v=4" width="60px" alt="1411430556" /></a>
|
||
</p>
|
||
|
||
## License
|
||
|
||
[MIT](./LICENSE) License
|
||
|
||
<p align="right">
|
||
<a href="#top">⬆️ 回到顶部</a>
|
||
</p>
|