|
1 |
| -# Vue 3 + Vite |
| 1 | +# Vue3、Vite5、Oxlint 最新的Web项目大屏模板 |
2 | 2 |
|
3 |
| -This template should help get you started developing with Vue 3 in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more. |
| 3 | +## 🍭 安装使用 |
4 | 4 |
|
5 |
| -Learn more about IDE Support for Vue in the [Vue Docs Scaling up Guide](https://vuejs.org/guide/scaling-up/tooling.html#ide-support). |
| 5 | +### 获取项目代码 |
| 6 | + |
| 7 | +```bash |
| 8 | +git clone https://github.com/gitboyzcf/vue3-simple-screen.git |
| 9 | +``` |
| 10 | + |
| 11 | +### 安装依赖 |
| 12 | + |
| 13 | +```sh |
| 14 | +pnpm install |
| 15 | +``` |
| 16 | + |
| 17 | +### 运行 |
| 18 | + |
| 19 | +```sh |
| 20 | +pnpm dev |
| 21 | +``` |
| 22 | + |
| 23 | +### 打包 |
| 24 | + |
| 25 | +```sh |
| 26 | +pnpm build |
| 27 | +``` |
| 28 | + |
| 29 | +## 🍩 浏览器支持 |
| 30 | + |
| 31 | +本地开发推荐使用`Chrome 80+` 浏览器 |
| 32 | + |
| 33 | +支持现代浏览器, 不支持 IE |
| 34 | + |
| 35 | +| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari | |
| 36 | +| :-: | :-: | :-: | :-: | :-: | |
| 37 | +| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions | |
| 38 | + |
| 39 | +## 🍻特性 |
| 40 | + |
| 41 | +- ⚡️ [Vue 3](https://github.com/vuejs/core)、 [Vite 5](https://vite.dev/)、[pnpm](https://pnpm.io/) |
| 42 | + |
| 43 | +- 📦 [组件自动化引入](https://github.com/unplugin/unplugin-vue-components) |
| 44 | + |
| 45 | +- 🍍 [使用 Pinia 的状态管理](https://pinia.vuejs.org) |
| 46 | + |
| 47 | +- 🌈 [Primevue](https://primevue.org/) - Vue.js UI 套件,提高开发效率 |
| 48 | + |
| 49 | +- 🎨 [UnoCSS](https://github.com/unocss/unocss) - 高性能且极具灵活性的即时原子化 CSS 引擎 |
| 50 | + |
| 51 | +- 😃 [各种图标集为你所用](https://icon-sets.iconify.design/) |
| 52 | + |
| 53 | +- 🔥 使用 [新的 `<script setup>` 语法](https://github.com/vuejs/rfcs/pull/227) |
| 54 | + |
| 55 | +- 📥 [API 自动加载](https://github.com/unplugin/unplugin-auto-import) - 直接使用 Composition API 无需引入 |
| 56 | + |
| 57 | +- 🌍 [API 采用模块化自动导入方式](https://blog.csdn.net/qq_43775179/article/details/134811292) 根据demo.js文件设置接口,以API_xxx_method的方式命名,在请求时无需导入 直接使用useRequest()函数返回参数以解构的方式获取,拿到即为写入的接口 |
| 58 | + |
| 59 | +- 💥 [Oxlint](https://oxc.rs/docs/guide/usage/linter.html)(英)+ [ESLint](https://eslint.org/)(英) - 双管齐下,享受高速度、强检查的代码格式化效果 |
| 60 | +- 🐶 [husky](https://typicode.github.io/husky/zh/) + [lint-staged](https://github.com/lint-staged/lint-staged?tab=readme-ov-file#-lint-staged) - Git提交自动检测格式化代码,解放双手 |
| 61 | + |
| 62 | +## 🍺 vscode 插件 |
| 63 | + |
| 64 | +- 🍭 editorconfig |
| 65 | +- 🍬 dotenv |
| 66 | +- 🍿 prettier-vscode |
| 67 | +- 🍪 vscode-eslint |
| 68 | +- 🍺 unocss |
| 69 | +- 🍦 iconify |
| 70 | +- 🍰 volar |
| 71 | +- 🎂 errorlens |
| 72 | +- 🍧 error-gutters |
| 73 | +- 🍼 gitlens |
| 74 | + |
| 75 | +## 🍣 Git 规范 |
| 76 | + |
| 77 | +参考 [Vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) 规范 |
| 78 | + |
| 79 | +- `✨ feat` 增加新功能 |
| 80 | +- `🐛 fix` 修复问题/BUG |
| 81 | +- `🎉 init` 初始化 |
| 82 | +- `📝 docs` 文档变更 |
| 83 | +- `💄 style` 代码格式(不影响代码运行的变动) |
| 84 | +- `♻️ refactor` 重构(既不是增加feature,也不是修复bug) |
| 85 | +- `⚡️ perf` 性能优化 |
| 86 | +- `✅ test` 增加测试 |
| 87 | +- `⏪️ revert` 回退 |
| 88 | +- `🚀 build` 构建过程或辅助工具的变动 |
| 89 | +- `👷 ci` CI 配置 |
| 90 | + |
| 91 | +## 图标使用方式 |
| 92 | + |
| 93 | +1. **前往图标库查找相关图标[icon](https://icon-sets.iconify.design/?category=General)** |
| 94 | +2. **安装图标所在的图标库** |
| 95 | + |
| 96 | + ```sh |
| 97 | + # 格式:pnpm add @iconify-json/[the-collection-you-want] -D |
| 98 | + |
| 99 | + # 例如 |
| 100 | + pnpm add @iconify-json/ep -D |
| 101 | + ``` |
| 102 | + |
| 103 | + 安装完后可以使用当前库下的所有图标 |
| 104 | + [https://icon-sets.iconify.design/ep/](https://icon-sets.iconify.design/ep/) |
| 105 | +3. **项目中使用** |
| 106 | + 使用unocss的方式[https://iconify.design/docs/usage/css/unocss/#icons-with-unocss](https://iconify.design/docs/usage/css/unocss/#icons-with-unocss) |
| 107 | + |
| 108 | + ```html |
| 109 | + <div class="i-ep-apple w-20px h-20px color-red"></div> |
| 110 | + ``` |
0 commit comments