English | 简体中文

特性

• ⚡️ Vue 3, Vite 3, pnpm, ESBuild - 快，且更快！
• 💪 Typescript - 当然！必不可少
• 🎉 Element Plus 开箱即用 - 基于 Vue.js 3 的强大 UI 库
• 🔥 Axios 配置和封装 - 基于 Promise 的 HTTP 请求库
• 💡 Vue Router 4 - Vuejs 的官方路由
• 📦 组件自动按需加载 - 自动按需注册组件, 无需 import
• 📥 API 自动按需加载 - 无需手动 import 进行引入
• 🍍 Pinia 状态管理 - 你将会喜欢上的 Vue Store
• 🎨 Windi CSS - 下一代实用的原子 css 框架
• 😃 icones - 强大的图标库，各种图标集为你所用
• 🌍 I18n 国际化开箱即用 - 想要翻译？是的，都可以！
• 👩‍🎨 NProgress - 页面加载进度反馈
• 😃 SVG 支持 - 支持以 组件形式使用 SVG 图片
• 📑 Markdown 支持 - 随意的在页面中嵌入 Markdown
• 🔑 完整支持的代码风格规范和代码提交规范
• ☁️ 支持零配置部署 Netlify

已配置

UI 框架

• Windi CSS (按需的 TailwindCSS) - 更轻，更快和和一系列额外的特性!
  • Windi CSS Typography
• Element Plus - 基于 Vue.js 3 的强大 UI 库

Icons

• 🔍Icônes - 使用任意的图标集
  • unplugin-icons - 自动按需引入你所需要的图标！

插件

• Vue Router 4 - Vuejs 的官方路由
• Pinia - 新一代的 Vue Store 状态管理
• Axios - 基于 Promise 的 HTTP 请求库
• unplugin-vue-components - 自动按需加载组件
• unplugin-auto-import - 自动按需加载 API
• vite-plugin-windicss - Windi CSS 的整合
• vite-plugin-vue-markdown - Markdown 作为组件，也可以让组件在 Markdown 中使用
  • markdown-it-prism - Prism 的语法高亮
  • prism-theme-vars - 利用 CSS 变量自定义 Prism.js 的主题
  • markdown-it-link-attributes - 统一设置 Markdown 里的超链接跳转方式
• Vue I18n - 国际化
  • vite-plugin-vue-i18n - Vue I18n 的 Vite 插件
• vite-plugin-fonts - Vite 的字体加载器
• VueUse - 实用的 Composition API 工具合集
• vite-svg-loader - 支持以 组件形式使用 SVG 图片

编码风格

• ESLint 配置为 Airbnb Style

开发工具

• TypeScript
• Netlify - 零配置的部署
• VS Code 扩展
  • Volar - Vue 3 IDE 支持
  • Iconify IntelliSense - 图标内联显示和自动补全
  • i18n Ally - 多合一的 I18n 支持
  • Windi CSS 智能感知 - Windi CSS 的 IDE 支持
  • ESLint - 代码质量和规则检查
  • Prettier - Code formatter - 专注于代码格式化、美化代码
  • EditorConfig for VS Code - 编码风格检查

现在可以试试!

如何贡献

你可以提一个 issue 或者提交一个 Pull Request。

Pull Request:

1. Fork 代码
2. 创建自己的分支: git checkout -b feat/xxxx
3. 提交你的修改: git commit -am 'feat(function): add xxxxx'
4. 推送您的分支: git push origin feat/xxxx
5. 提交 pull request

Git 贡献提交规范

• feat 新功能
• fix 修补 bug
• docs 文档
• style 格式、样式(不影响代码运行的变动)
• refactor 重构(即不是新增功能，也不是修改 BUG 的代码)
• perf 优化相关，比如提升性能、体验
• test 添加测试
• build 编译相关的修改，对项目构建或者依赖的改动
• ci 持续集成修改
• chore 构建过程或辅助工具的变动
• revert 回滚到上一个版本
• workflow 工作流改进
• mod 不确定分类的修改
• wip 开发中
• types 类型

Gitee 模板

使用这个模板创建仓库.

克隆到本地

git clone https://gitee.com/taiping520/wit-admin.git my-vitecamp-app
cd my-vitecamp-app
pnpm i

然后，你就可以享受编写代码的乐趣了 :)

使用

开发

只需要执行以下命令就可以在 http://localhost:8080 中看到

pnpm run dev

构建

构建该应用只需要执行以下命令

pnpm run build

然后你会看到用于发布的 dist 文件夹被生成。