中文 | English
🐬 A Starter template built on Vite 5.x + Vue 3.x + Element Plus 2.x + TypeScript + Husky + lint-staged.
一个开箱即用，适合快速开发 Vue3 + Vite5 + TS 中小型 B 端后台管理系统的原型模板项目框架，持续更新最新技术栈 💪
目前一共有以下五个不同技术栈的仓库模板在持续维护，请尝试后选择适合自己的模板使用
-
💥 (推荐) TS + Pinia + 🌐 低耦合(i18n)多语言 Vite5 + Vue3 + TS + Element-Plus2 + vue-i18n@next
-
⚡️ TS + Pinia 版 Vite5 + Vue3 + TS + Pinia + Element-Plus2 + useLocale + i18n
-
⚡️ JS + Pinia 版 Vite5 + Vue3 + Pinia + Element-Plus2 + useLocale + i18n
-
⚡️ TS + Vuex4 版 (当前仓库)Vite5 + Vue3 + TS + Vuex4 + Element-Plus2 + useLocale + i18n
-
⚡️ JS + Vuex4 版 Vite5 + Vue3 + Vuex4 + Element-Plus2 + useLocale + i18n
如果更偏好使用 Naive UI 作为 UI 库, 这里也为你准备了几个相应的模板项目，可在此基础上进行业务二次开发和定制：
- 支持 Vite 5 + Vue 3 + TypeScript
- UI 框架: Element Plus 2.x
- 状态管理: Vuex 4
- 代码规范化检测: Husky + lint-staged
- 单元测试框架:
Jest升级为 Vitest - 内置 ESlint 和 Stylelint, 可在此基础上扩展你想要的 Lint 配置规范
- 内置封装了一个可能比较好用的 Axios , 需要时配合 Vuex Actions 一起食用
- 封装了 <IconFont /> 组件, 可直接使用 IconFont 图标
- 内置全局 $ModalDialog 插件, 支持使用 service 式地动态调用此插件来显示任意组件
- 内置 i18n, 支持到 VueRouter 路由级别切换语言，可编写国际化配置文件及扩展其他语言
- 路由鉴权已帮你封装好，同时配合 Nprogress, 只需要修改 permission.ts 文件即可
- 自带一个模块化的组件开发环境，可按照 modules 目录解耦页面组件、路由组件、样式等文件
- 高度封装但不失灵活，内部抽象出了一个完整的业务流程供你参考，涉及三个核心页面：登录、列表和明细
- 节省你配置的时间，因此该项目的轻量化致使你只需要专心编写自己的业务代码即可
- Vue 3.x
- Node >= 18.12.x
- Pnpm 9.x
- VS Code 插件
dbaeumer.vscode-eslint>= v3.0.5 (pre-release)
- 安装依赖
pnpm i- 本地开发
pnpm dev- 执行单测
pnpm test- 执行覆盖率测试
pnpm test:coverage本项目支持多语言设置，默认语言为 English.
默认语言通过 defaultLanguageLocale 常量设置。要更改默认语言，只需修改此常量的值：
export const defaultLanguageLocale = 'en'项目当前支持以下语言，详见代码src/locales/index.ts:
export const localesMapping = [
{
localeCode: 'zh-hans',
localeName: '简体中文',
localeLang: {...}
},
{
localeCode: 'en',
localeName: 'English',
localeLang: {...}
}
]要添加新的语言支持:
-
在
localesMapping数组中添加新的语言对象 -
在
src/locales/lang/目录下创建对应的语言文件（如 de.ts 为德语）./lang ├── en.ts └── zh-hans.ts -
导入并合并
Element Plus语言包和自定义语言文件，确保 UI 组件和自定义内容均被本地化
- 若 Husky 未生效，可能是由于未完成初始化，尝试执行以下命令进行初始化:
pnpm run prepare