241 lines
9.7 KiB
Markdown
241 lines
9.7 KiB
Markdown
<p align="center">
|
||
<img width="320" src="https://wpimg.wallstcn.com/ecc53a42-d79b-42e2-8852-5126b810a4c8.svg">
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="https://github.com/vuejs/vue">
|
||
<img src="https://img.shields.io/badge/vue-2.6.10-brightgreen.svg" alt="vue">
|
||
</a>
|
||
<a href="https://github.com/ElemeFE/element">
|
||
<img src="https://img.shields.io/badge/element--ui-2.7.0-brightgreen.svg" alt="element-ui">
|
||
</a>
|
||
<a href="https://travis-ci.org/PanJiaChen/vue-element-admin" rel="nofollow">
|
||
<img src="https://travis-ci.org/PanJiaChen/vue-element-admin.svg?branch=master" alt="Build Status">
|
||
</a>
|
||
<a href="https://github.com/PanJiaChen/vue-element-admin/blob/master/LICENSE">
|
||
<img src="https://img.shields.io/github/license/mashape/apistatus.svg" alt="license">
|
||
</a>
|
||
<a href="https://github.com/PanJiaChen/vue-element-admin/releases">
|
||
<img src="https://img.shields.io/github/release/PanJiaChen/vue-element-admin.svg" alt="GitHub release">
|
||
</a>
|
||
<a href="https://gitter.im/vue-element-admin/discuss">
|
||
<img src="https://badges.gitter.im/Join%20Chat.svg" alt="gitter">
|
||
</a>
|
||
<a href="https://panjiachen.gitee.io/vue-element-admin-site/zh/donate">
|
||
<img src="https://img.shields.io/badge/%24-donate-ff69b4.svg" alt="donate">
|
||
</a>
|
||
</p>
|
||
|
||
简体中文 | [English](./README.md) | [日本語](./README.ja.md) | [Spanish](./README.es.md)
|
||
|
||
## 简介
|
||
|
||
[vue-element-admin](https://panjiachen.github.io/vue-element-admin) 是一个后台前端解决方案，它基于 [vue](https://github.com/vuejs/vue) 和 [element-ui](https://github.com/ElemeFE/element)实现。它使用了最新的前端技术栈，内置了 i18n 国际化解决方案，动态路由，权限验证，提炼了典型的业务模型，提供了丰富的功能组件，它可以帮助你快速搭建企业级中后台产品原型。相信不管你的需求是什么，本项目都能帮助到你。
|
||
|
||
- [在线预览](https://panjiachen.github.io/vue-element-admin)
|
||
|
||
- [使用文档](https://panjiachen.github.io/vue-element-admin-site/zh/)
|
||
|
||
- [Gitter 讨论组](https://gitter.im/vue-element-admin/discuss)
|
||
|
||
- [Donate](https://panjiachen.gitee.io/vue-element-admin-site/zh/donate)
|
||
|
||
- [Wiki](https://github.com/PanJiaChen/vue-element-admin/wiki)
|
||
|
||
- [Gitee](https://panjiachen.gitee.io/vue-element-admin/) 在线预览（国内用户可访问该地址）
|
||
|
||
- [国内访问文档](https://panjiachen.gitee.io/vue-element-admin-site/zh/) 文档（方便没翻墙的用户查看）
|
||
|
||
- 基础模板建议使用: [vue-admin-template](https://github.com/PanJiaChen/vue-admin-template)
|
||
- 桌面端: [electron-vue-admin](https://github.com/PanJiaChen/electron-vue-admin)
|
||
- Typescript 版: [vue-typescript-admin-template](https://github.com/Armour/vue-typescript-admin-template) (鸣谢: [@Armour](https://github.com/Armour))
|
||
- [awesome-project](https://github.com/PanJiaChen/vue-element-admin/issues/2312)
|
||
|
||
**`v4.1.0+`版本之后默认 master 分支将不支持国际化，有需要的请使用[i18n](https://github.com/PanJiaChen/vue-element-admin/tree/i18n)分支，它会和 master 保持同步更新**
|
||
|
||
**该项目不支持低版本浏览器(如 ie)，有需求请自行添加 polyfill [详情](https://github.com/PanJiaChen/vue-element-admin/wiki#babel-polyfill)**
|
||
|
||
**目前版本为 `v4.0+` 基于 `vue-cli` 进行构建，若发现问题，欢迎提[issue](https://github.com/PanJiaChen/vue-element-admin/issues/new)。若你想使用旧版本，可以切换分支到[tag/3.11.0](https://github.com/PanJiaChen/vue-element-admin/tree/tag/3.11.0)，它不依赖 `vue-cli`**
|
||
|
||
群主 **[圈子](https://jianshiapp.com/circles/1209)** 群主会经常分享一些技术相关的东西，或者加入 [qq 群](https://github.com/PanJiaChen/vue-element-admin/issues/602) 或者关注 [微博](https://weibo.com/u/3423485724?is_all=1)
|
||
|
||
## 前序准备
|
||
|
||
你需要在本地安装 [node](http://nodejs.org/) 和 [git](https://git-scm.com/)。本项目技术栈基于 [ES2015+](http://es6.ruanyifeng.com/)、[vue](https://cn.vuejs.org/index.html)、[vuex](https://vuex.vuejs.org/zh-cn/)、[vue-router](https://router.vuejs.org/zh-cn/) 、[vue-cli](https://github.com/vuejs/vue-cli) 、[axios](https://github.com/axios/axios) 和 [element-ui](https://github.com/ElemeFE/element)，所有的请求数据都使用[Mock.js](https://github.com/nuysoft/Mock)进行模拟，提前了解和学习这些知识会对使用本项目有很大的帮助。
|
||
|
||
同时配套了系列教程文章，如何从零构建后一个完整的后台项目，建议大家先看完这些文章再来实践本项目
|
||
|
||
- [手摸手，带你用 vue 撸后台 系列一(基础篇)](https://juejin.im/post/59097cd7a22b9d0065fb61d2)
|
||
- [手摸手，带你用 vue 撸后台 系列二(登录权限篇)](https://juejin.im/post/591aa14f570c35006961acac)
|
||
- [手摸手，带你用 vue 撸后台 系列三 (实战篇)](https://juejin.im/post/593121aa0ce4630057f70d35)
|
||
- [手摸手，带你用 vue 撸后台 系列四(vueAdmin 一个极简的后台基础模板)](https://juejin.im/post/595b4d776fb9a06bbe7dba56)
|
||
- [手摸手，带你用vue撸后台 系列五(v4.0新版本)](https://juejin.im/post/5c92ff94f265da6128275a85)
|
||
- [手摸手，带你封装一个 vue component](https://segmentfault.com/a/1190000009090836)
|
||
- [手摸手，带你优雅的使用 icon](https://juejin.im/post/59bb864b5188257e7a427c09)
|
||
- [手摸手，带你用合理的姿势使用 webpack4（上）](https://juejin.im/post/5b56909a518825195f499806)
|
||
- [手摸手，带你用合理的姿势使用 webpack4（下）](https://juejin.im/post/5b5d6d6f6fb9a04fea58aabc)
|
||
|
||
**如有问题请先看上述使用文档和文章，若不能满足，欢迎 issue 和 pr**
|
||
|
||
<p align="center">
|
||
<img width="900" src="https://wpimg.wallstcn.com/a5894c1b-f6af-456e-82df-1151da0839bf.png">
|
||
</p>
|
||
|
||
## Sponsors
|
||
|
||
Become a sponsor and get your logo on our README on GitHub with a link to your site. [[Become a sponsor]](https://www.patreon.com/panjiachen)
|
||
|
||
<a href="https://flatlogic.com/admin-dashboards?from=vue-element-admin"><img width="150px" src="https://wpimg.wallstcn.com/9c0b719b-5551-4c1e-b776-63994632d94a.png" /></a><p>Admin Dashboard Templates made with Vue, React and Angular.</p>
|
||
|
||
## 功能
|
||
|
||
```
|
||
- 登录 / 注销
|
||
|
||
- 权限验证
|
||
- 页面权限
|
||
- 指令权限
|
||
- 权限配置
|
||
- 二步登录
|
||
|
||
- 多环境发布
|
||
- dev sit stage prod
|
||
|
||
- 全局功能
|
||
- 国际化多语言
|
||
- 多种动态换肤
|
||
- 动态侧边栏（支持多级路由嵌套）
|
||
- 动态面包屑
|
||
- 快捷导航(标签页)
|
||
- Svg Sprite 图标
|
||
- 本地/后端 mock 数据
|
||
- Screenfull全屏
|
||
- 自适应收缩侧边栏
|
||
|
||
- 编辑器
|
||
- 富文本
|
||
- Markdown
|
||
- JSON 等多格式
|
||
|
||
- Excel
|
||
- 导出excel
|
||
- 导入excel
|
||
- 前端可视化excel
|
||
- 导出zip
|
||
|
||
- 表格
|
||
- 动态表格
|
||
- 拖拽表格
|
||
- 内联编辑
|
||
|
||
- 错误页面
|
||
- 401
|
||
- 404
|
||
|
||
- 組件
|
||
- 头像上传
|
||
- 返回顶部
|
||
- 拖拽Dialog
|
||
- 拖拽Select
|
||
- 拖拽看板
|
||
- 列表拖拽
|
||
- SplitPane
|
||
- Dropzone
|
||
- Sticky
|
||
- CountTo
|
||
|
||
- 综合实例
|
||
- 错误日志
|
||
- Dashboard
|
||
- 引导页
|
||
- ECharts 图表
|
||
- Clipboard(剪贴复制)
|
||
- Markdown2html
|
||
```
|
||
|
||
## 开发
|
||
|
||
```bash
|
||
# 克隆项目
|
||
git clone https://github.com/PanJiaChen/vue-element-admin.git
|
||
|
||
# 进入项目目录
|
||
cd vue-element-admin
|
||
|
||
# 安装依赖
|
||
npm install
|
||
|
||
# 建议不要直接使用 cnpm 安装依赖，会有各种诡异的 bug。可以通过如下操作解决 npm 下载速度慢的问题
|
||
npm install --registry=https://registry.npm.taobao.org
|
||
|
||
# 启动服务
|
||
npm run dev
|
||
```
|
||
|
||
浏览器访问 http://localhost:9527
|
||
|
||
## 发布
|
||
|
||
```bash
|
||
# 构建测试环境
|
||
npm run build:stage
|
||
|
||
# 构建生产环境
|
||
npm run build:prod
|
||
```
|
||
|
||
## 其它
|
||
|
||
```bash
|
||
# 预览发布环境效果
|
||
npm run preview
|
||
|
||
# 预览发布环境效果 + 静态资源分析
|
||
npm run preview -- --report
|
||
|
||
# 代码格式检查
|
||
npm run lint
|
||
|
||
# 代码格式检查并自动修复
|
||
npm run lint -- --fix
|
||
```
|
||
|
||
更多信息请参考 [使用文档](https://panjiachen.github.io/vue-element-admin-site/zh/)
|
||
|
||
## Changelog
|
||
|
||
Detailed changes for each release are documented in the [release notes](https://github.com/PanJiaChen/vue-element-admin/releases).
|
||
|
||
## Online Demo
|
||
|
||
[在线 Demo](https://panjiachen.github.io/vue-element-admin)
|
||
|
||
## Donate
|
||
|
||
如果你觉得这个项目帮助到了你，你可以帮作者买一杯果汁表示鼓励 :tropical_drink:
|
||
|
||
|
||
[更多捐赠方式](https://panjiachen.gitee.io/vue-element-admin-site/zh/donate)
|
||
|
||
[Paypal Me](https://www.paypal.me/panfree23)
|
||
|
||
[Buy me a coffee](https://www.buymeacoffee.com/Pan)
|
||
|
||
## 购买贴纸
|
||
|
||
你也可以通过 购买[官方授权的贴纸](https://smallsticker.com/product/vue-element-admin) 的方式来支持 vue-element-admin - 每售出一张贴纸，本项目将获得 2 元的捐赠。
|
||
|
||
## Browsers support
|
||
|
||
Modern browsers and Internet Explorer 10+.
|
||
|
||
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](https://godban.github.io/browsers-support-badges/)</br>IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](https://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" />](https://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" />](https://godban.github.io/browsers-support-badges/)</br>Safari |
|
||
| --------- | --------- | --------- | --------- |
|
||
| IE10, IE11, Edge| last 2 versions| last 2 versions| last 2 versions
|
||
|
||
## License
|
||
|
||
[MIT](https://github.com/PanJiaChen/vue-element-admin/blob/master/LICENSE)
|
||
|
||
Copyright (c) 2017-present PanJiaChen
|