README.md 9.5 KB
Newer Older
花裤衩 已提交
1
<p align="center">
花裤衩 已提交
2
  <img width="320" src="https://wpimg.wallstcn.com/ecc53a42-d79b-42e2-8852-5126b810a4c8.svg">
花裤衩 已提交
3 4
</p>

花裤衩 已提交
5
<p align="center">
6
  <a href="https://github.com/vuejs/vue">
花裤衩 已提交
7
    <img src="https://img.shields.io/badge/vue-2.6.10-brightgreen.svg" alt="vue">
8 9
  </a>
  <a href="https://github.com/ElemeFE/element">
花裤衩 已提交
10
    <img src="https://img.shields.io/badge/element--ui-2.7.0-brightgreen.svg" alt="element-ui">
11 12 13 14 15 16 17 18 19 20
  </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>
P
docs  
Pan 已提交
21 22 23 24 25 26
  <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.github.io/vue-element-admin-site/donate">
    <img src="https://img.shields.io/badge/%24-donate-ff69b4.svg" alt="donate">
  </a>
花裤衩 已提交
27
</p>
花裤衩 已提交
28

29
English | [简体中文](./README.zh-CN.md) | [日本語](./README.ja.md) | [Spanish](./README.es.md)
花裤衩 已提交
30

花裤衩 已提交
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
<p align="center">
  <b>SPONSORED BY</b>
</p>
<table align="center" cellspacing="0" cellpadding="0">
  <tbody>
    <tr>
      <td align="center" valign="middle" width="250">
        <a href="https://www.duohui.cn/?utm_source=vue-element-admin&utm_medium=web&utm_campaign=vue-element-admin_github" title="多会" target="_blank">
          <img height="60px" src="https://qiniu.cdn.duohui.co/brand/duohui.png" title="多会 - 活动服务销售平台">
          <p>活动服务销售平台</p>
        </a>
      </td>
      <td align="center" valign="middle" width="250">
        <a href="https://youke.co/?utm_source=vue-element-admin&utm_medium=web&utm_campaign=vue-element-admin_github" title="有客" target="_blank">
          <img height="60px" src="https://qiniu.cdn.duohui.co/brand/youke.png" title="有客 - 客户消息直达工作群">
          <p>客户消息直达工作群</p>
        </a>
      </td>
    </tr>
  </tbody>
</table>

花裤衩 已提交
53
## Introduction
花裤衩 已提交
54

B
BradyBromley 已提交
55
[vue-element-admin](https://panjiachen.github.io/vue-element-admin) is a production-ready front-end solution for admin interfaces. It is based on [vue](https://github.com/vuejs/vue) and uses the UI Toolkit [element-ui](https://github.com/ElemeFE/element).
P
Pan 已提交
56

B
BradyBromley 已提交
57
[vue-element-admin](https://panjiachen.github.io/vue-element-admin) is based on the newest development stack of vue and it has a built-in i18n solution, typical templates for enterprise applications, and lots of awesome features. It helps you build large and complex Single-Page Applications. I believe whatever your needs are, this project will help you.
P
refine  
Pan 已提交
58

P
Pan 已提交
59
- [Preview](https://panjiachen.github.io/vue-element-admin)
P
Pan 已提交
60

P
Pan 已提交
61
- [Documentation](https://panjiachen.github.io/vue-element-admin-site/)
P
refine  
Pan 已提交
62

P
Pan 已提交
63 64
- [Gitter](https://gitter.im/vue-element-admin/discuss)

P
Pan 已提交
65
- [Donate](https://panjiachen.github.io/vue-element-admin-site/donate/)
花裤衩 已提交
66

花裤衩 已提交
67
- [Wiki](https://github.com/PanJiaChen/vue-element-admin/wiki)
P
Pan 已提交
68

花裤衩 已提交
69
- [Gitee](https://panjiachen.gitee.io/vue-element-admin/) 国内用户可访问该地址在线预览
T
ttop5 已提交
70

71
- Base template recommends using: [vue-admin-template](https://github.com/PanJiaChen/vue-admin-template)
P
Pan 已提交
72
- Desktop: [electron-vue-admin](https://github.com/PanJiaChen/electron-vue-admin)
73
- Typescript: [vue-typescript-admin-template](https://github.com/Armour/vue-typescript-admin-template) (Credits: [@Armour](https://github.com/Armour))
花裤衩 已提交
74
- [awesome-project](https://github.com/PanJiaChen/vue-element-admin/issues/2312)
P
Pan 已提交
75

花裤衩 已提交
76 77 78
**After the `v4.1.0+` version, the default master branch will not support i18n. Please use [i18n Branch](https://github.com/PanJiaChen/vue-element-admin/tree/i18n), it will keep up with the master update**

**The current version is `v4.0+` build on `vue-cli`. If you find a problem, please put [issue](https://github.com/PanJiaChen/vue-element-admin/issues/new). If you want to use the old version , you can switch branch to [tag/3.11.0](https://github.com/PanJiaChen/vue-element-admin/tree/tag/3.11.0), it does not rely on `vue-cli`**
P
Pan 已提交
79

花裤衩 已提交
80
**This project does not support low version browsers (e.g. IE). Please add polyfill by yourself.**
P
Pan 已提交
81

花裤衩 已提交
82
## Preparation
P
Pan 已提交
83

P
Pan 已提交
84
You need to install [node](https://nodejs.org/) and [git](https://git-scm.com/) locally. The project is based on [ES2015+](https://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) and [element-ui](https://github.com/ElemeFE/element), all request data is simulated using [Mock.js](https://github.com/nuysoft/Mock).
P
Pan 已提交
85
Understanding and learning this knowledge in advance will greatly help the use of this project.
P
Pan 已提交
86

87 88
[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/PanJiaChen/vue-element-admin/tree/CodeSandbox)

89
<p align="center">
90 91
  <img width="900" src="https://wpimg.wallstcn.com/a5894c1b-f6af-456e-82df-1151da0839bf.png">
</p>
P
refine  
Pan 已提交
92

P
Pan 已提交
93
## Sponsors
花裤衩 已提交
94

P
Pan 已提交
95 96
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)

97
### Akveo
花裤衩 已提交
98 99
<a href="https://store.akveo.com/products/vue-java-admin-dashboard-spring?utm_campaign=akveo_store-Vue-Vue_demo%2Fgithub&utm_source=vue_admin&utm_medium=referral&utm_content=github_banner"><img width="500px" src="https://raw.githubusercontent.com/PanJiaChen/vue-element-admin-site/master/docs/.vuepress/public/images/vue-java-banner.png" /></a><p>Get Java backend for Vue admin with 20% discount for 39$ use coupon code SWB0RAZPZR1M
</p>
100 101 102

### Flatlogic

P
Pan 已提交
103 104
<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>

花裤衩 已提交
105
## Features
P
Pan 已提交
106

花裤衩 已提交
107 108
```
- Login / Logout
P
Pan 已提交
109 110 111 112

- Permission Authentication
  - Page permission
  - Directive permission
花裤衩 已提交
113
  - Permission configuration page
P
Pan 已提交
114 115
  - Two-step login

花裤衩 已提交
116
- Multi-environment build
117 118 119 120
  - Develop (dev)
  - sit
  - Stage Test (stage)
  - Production (prod)
P
Pan 已提交
121 122 123 124 125 126

- Global Features
  - I18n
  - Multiple dynamic themes
  - Dynamic sidebar (supports multi-level routing)
  - Dynamic breadcrumb
N
Nikita Sobolev 已提交
127
  - Tags-view (Tab page Support right-click operation)
P
Pan 已提交
128 129 130 131 132 133 134 135 136 137 138 139 140 141
  - Svg Sprite
  - Mock data
  - Screenfull
  - Responsive Sidebar

- Editor
  - Rich Text Editor
  - Markdown Editor
  - JSON Editor

- Excel
  - Export Excel
  - Upload Excel
  - Visualization Excel
花裤衩 已提交
142
  - Export zip
P
Pan 已提交
143 144 145 146 147 148 149 150 151 152 153 154 155 156

- Table
  - Dynamic Table
  - Drag And Drop Table
  - Inline Edit Table

- Error Page
  - 401
  - 404

- Components
  - Avatar Upload
  - Back To Top
  - Drag Dialog
157
  - Drag Select
P
Pan 已提交
158 159 160 161 162 163 164 165 166
  - Drag Kanban
  - Drag List
  - SplitPane
  - Dropzone
  - Sticky
  - CountTo

- Advanced Example
- Error Log
P
Pan 已提交
167
- Dashboard
花裤衩 已提交
168
- Guide Page
P
Pan 已提交
169
- ECharts
花裤衩 已提交
170
- Clipboard
171
- Markdown to html
花裤衩 已提交
172 173 174
```

## Getting started
P
refine  
Pan 已提交
175

P
refine  
Pan 已提交
176
```bash
P
Pan 已提交
177
# clone the project
花裤衩 已提交
178
git clone https://github.com/PanJiaChen/vue-element-admin.git
P
refine  
Pan 已提交
179

花裤衩 已提交
180 181 182
# enter the project directory
cd vue-element-admin

花裤衩 已提交
183 184
# install dependency
npm install
P
refine  
Pan 已提交
185

花裤衩 已提交
186 187
# develop
npm run dev
P
refine  
Pan 已提交
188
```
P
refine  
Pan 已提交
189

花裤衩 已提交
190
This will automatically open http://localhost:9527
花裤衩 已提交
191 192

## Build
P
Pan 已提交
193

P
Pan 已提交
194
```bash
花裤衩 已提交
195
# build for test environment
花裤衩 已提交
196
npm run build:stage
197

花裤衩 已提交
198 199
# build for production environment
npm run build:prod
200 201
```

花裤衩 已提交
202
## Advanced
P
Pan 已提交
203

204
```bash
花裤衩 已提交
205 206
# preview the release environment effect
npm run preview
花裤衩 已提交
207

花裤衩 已提交
208 209
# preview the release environment effect + static resource analysis
npm run preview -- --report
P
Pan 已提交
210

花裤衩 已提交
211
# code format check
花裤衩 已提交
212
npm run lint
P
refine  
Pan 已提交
213

花裤衩 已提交
214
# code format check and auto fix
花裤衩 已提交
215
npm run lint -- --fix
P
refine  
Pan 已提交
216 217
```

P
Pan 已提交
218
Refer to [Documentation](https://panjiachen.github.io/vue-element-admin-site/guide/essentials/deploy.html) for more information
花裤衩 已提交
219

P
Pan 已提交
220
## Changelog
P
Pan 已提交
221

P
Pan 已提交
222 223
Detailed changes for each release are documented in the [release notes](https://github.com/PanJiaChen/vue-element-admin/releases).

224
## Online Demo
P
Pan 已提交
225

P
Pan 已提交
226
[Preview](https://panjiachen.github.io/vue-element-admin)
P
Pan 已提交
227 228

## Donate
P
Pan 已提交
229

花裤衩 已提交
230 231 232 233 234
If you find this project useful, you can buy author a glass of juice :tropical_drink:

![donate](https://wpimg.wallstcn.com/bd273f0d-83a0-4ef2-92e1-9ac8ed3746b9.png)

[Paypal Me](https://www.paypal.me/panfree23)
花裤衩 已提交
235

花裤衩 已提交
236 237
[Buy me a coffee](https://www.buymeacoffee.com/Pan)

P
Pan 已提交
238 239 240 241
## Browsers support

Modern browsers and Internet Explorer 10+.

P
Pan 已提交
242
| [<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 |
P
Pan 已提交
243
| --------- | --------- | --------- | --------- |
244
| IE10, IE11, Edge | last 2 versions | last 2 versions | last 2 versions |
P
Pan 已提交
245

花裤衩 已提交
246 247
## License

花裤衩 已提交
248 249
[MIT](https://github.com/PanJiaChen/vue-element-admin/blob/master/LICENSE)

P
Pan 已提交
250
Copyright (c) 2017-present PanJiaChen