README.zh-CN.md

vue-element-plus-admin

English | 中文

介绍

vue-element-plus-admin 是一个基于 element-plus 免费开源的中后台模版。使用了最新的vue3，vite，TypeScript等主流技术开发，开箱即用的中后台前端解决方案，可以用来作为项目的启动模版，也可用于学习参考。并且时刻关注着最新技术动向，尽可能的第一时间更新。

vue-element-plus-admin 的定位是后台集成方案，不太适合当基础模板来进行二次开发。因为集成了很多你可能用不到的功能，会造成不少的代码冗余。如果你的项目不关注这方面的问题，也可以直接基于它进行二次开发。

如需要基础模版，请切换到 mini 分支，mini 只简单集成了一些如：布局、动态菜单等常用布局功能，更适合开发者进行二次开发。

特性

• 最新技术栈：使用 Vue3/vite4 等前端前沿技术开发
• TypeScript: 应用程序级 JavaScript 的语言
• 主题: 可配置的主题
• 国际化：内置完善的国际化方案
• 自定义数据 内置 Mock 数据方案
• 权限 内置完善的动态路由权限生成方案
• 组件 二次封装了多个常用的组件
• 示例 内置丰富的示例

预览

• vue-element-plus-admin - 完整版 github 站点
• vue-element-plus-admin - 完整版 gitee 站点

帐号：admin/admin

在线例子默认不适用菜单过滤，而是直接使用静态路由表

文档

文档地址 Github

文档地址 Gitee

前序准备

• node 和 git - 项目开发环境
• Vite - 熟悉 vite 特性
• Vue3 - 熟悉 Vue 基础语法
• TypeScript - 熟悉 TypeScript 基本语法
• Es6+ - 熟悉 es6 基本语法
• Vue-Router-Next - 熟悉 vue-router 基本使用
• Element-Plus - element-plus 基本使用
• Faker.js - 生成大量伪造的上下文数据

安装和使用

• 获取代码

git clone https://github.com/kailong321200875/vue-element-plus-admin.git

• 安装依赖

cd vue-element-plus-admin

pnpm install

• 运行

pnpm run dev

• 打包

pnpm run build:pro

更新日志

更新日志

如何贡献

你可以提一个 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 类型

浏览器支持

本地开发推荐使用 Chrome 80+ 浏览器

支持现代浏览器, 不支持 IE

IE	Edge	Firefox	Chrome	Safari
not support	last 2 versions	last 2 versions	last 2 versions	last 2 versions

Donate

如果你觉得这个项目有帮助，欢迎赞助以示支持~

Paypal Me

交流群

如果你想进入技术交流群讨论，请添加我为好友

许可证

MIT