README.zh-CN.md 9.3 KB



[![license](https://img.shields.io/github/license/kailong321200875/vue-element-plus-admin.svg)](LICENSE)

vue-element-plus-admin

English | 中文

介绍

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

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

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

特性

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

预览

帐号:admin/admin test/test

admin 帐号用于模拟服务端控制权限,服务端返回什么就渲染什么

test 帐号用于模拟前端控制权限,服务端只返回需要显示的菜单 key,前端进行匹配渲染

文档

文档地址 Github

文档地址 Gitee

前序准备

安装和使用

  • 获取代码

    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

IEEdgeFirefox
 Edge
 Edge
Firefox
ChromeChrome SafariSafari not support last 2 versions last 2 versions last 2 versions last 2 versions

许可证

MIT

合作者

<td align="center">
    <a href="https://github.com/niyg">
        <img src="https://avatars.githubusercontent.com/u/14817820?v=4" width="100;" alt="niyg"/>
        <br />
        <sub><b>福州-大雨</b></sub>
    </a>
</td>
<td align="center">
    <a href="https://github.com/git-Where">
        <img src="https://avatars.githubusercontent.com/u/16344566?v=4" width="100;" alt="git-Where"/>
        <br />
        <sub><b>葉家男孩</b></sub>
    </a>
</td>
<td align="center">
    <a href="https://github.com/z6w6j6">
        <img src="https://avatars.githubusercontent.com/u/23661303?v=4" width="100;" alt="z6w6j6"/>
        <br />
        <sub><b>Z6w6j6</b></sub>
    </a>
</td>
<td align="center">
    <a href="https://github.com/kailong321200875">
        <img src="https://avatars.githubusercontent.com/u/32283845?v=4" width="100;" alt="kailong321200875"/>
        <br />
        <sub><b>Archer</b></sub>
    </a>
</td></tr>

贡献者

<td align="center">
    <a href="https://github.com/kailong321200875">
        <img src="https://avatars.githubusercontent.com/u/32283845?v=4" width="100;" alt="kailong321200875"/>
        <br />
        <sub><b>Archer</b></sub>
    </a>
</td>
<td align="center">
    <a href="https://github.com/kailong502431556">
        <img src="https://avatars.githubusercontent.com/u/30221169?v=4" width="100;" alt="kailong502431556"/>
        <br />
        <sub><b>Kailong502431556</b></sub>
    </a>
</td>
<td align="center">
    <a href="https://github.com/xingyu4j">
        <img src="https://avatars.githubusercontent.com/u/41043753?v=4" width="100;" alt="xingyu4j"/>
        <br />
        <sub><b>Xingyu4j</b></sub>
    </a>
</td>
<td align="center">
    <a href="https://github.com/snowords">
        <img src="https://avatars.githubusercontent.com/u/22708432?v=4" width="100;" alt="snowords"/>
        <br />
        <sub><b>Snoword</b></sub>
    </a>
</td>
<td align="center">
    <a href="https://github.com/huanghong1125">
        <img src="https://avatars.githubusercontent.com/u/12794817?v=4" width="100;" alt="huanghong1125"/>
        <br />
        <sub><b>Huanghong</b></sub>
    </a>
</td>
<td align="center">
    <a href="https://github.com/macrossx">
        <img src="https://avatars.githubusercontent.com/u/19276552?v=4" width="100;" alt="macrossx"/>
        <br />
        <sub><b>Macrossx</b></sub>
    </a>
</td></tr>

<td align="center">
    <a href="https://github.com/hongxinzz">
        <img src="https://avatars.githubusercontent.com/u/31195324?v=4" width="100;" alt="hongxinzz"/>
        <br />
        <sub><b>Hongxinzz</b></sub>
    </a>
</td>
<td align="center">
    <a href="https://github.com/amifed">
        <img src="https://avatars.githubusercontent.com/u/36906371?v=4" width="100;" alt="amifed"/>
        <br />
        <sub><b>Yangyu</b></sub>
    </a>
</td>
<td align="center">
    <a href="https://github.com/WuYihui">
        <img src="https://avatars.githubusercontent.com/u/29938095?v=4" width="100;" alt="WuYihui"/>
        <br />
        <sub><b>WuYihui</b></sub>
    </a>
</td>
<td align="center">
    <a href="https://github.com/xiterjia">
        <img src="https://avatars.githubusercontent.com/u/3360879?v=4" width="100;" alt="xiterjia"/>
        <br />
        <sub><b>Xiterjia</b></sub>
    </a>
</td>
<td align="center">
    <a href="https://github.com/z6w6j6">
        <img src="https://avatars.githubusercontent.com/u/23661303?v=4" width="100;" alt="z6w6j6"/>
        <br />
        <sub><b>Z6w6j6</b></sub>
    </a>
</td></tr>