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

花裤衩's avatar
花裤衩 committed
5
<p align="center">
6
7
8
9
  <a href="https://github.com/vuejs/vue">
    <img src="https://img.shields.io/badge/vue-2.5.10-brightgreen.svg" alt="vue">
  </a>
  <a href="https://github.com/ElemeFE/element">
Pan's avatar
Pan committed
10
    <img src="https://img.shields.io/badge/element--ui-2.3.2-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>
花裤衩's avatar
花裤衩 committed
21
</p>
花裤衩's avatar
花裤衩 committed
22

花裤衩's avatar
花裤衩 committed
23
English | [简体中文](./README.zh-CN.md)
花裤衩's avatar
花裤衩 committed
24

花裤衩's avatar
花裤衩 committed
25
## Introduction
花裤衩's avatar
花裤衩 committed
26

Pan's avatar
Pan committed
27
[vue-element-admin](http://panjiachen.github.io/vue-element-admin) is a front-end management background integration solution. It based on [vue](https://github.com/vuejs/vue) and use the UI Toolkit [element](https://github.com/ElemeFE/element).
Pan's avatar
Pan committed
28

Pan's avatar
Pan committed
29
It is a magical vue admin based on the newest development stack of vue, built-in i18n solution, typical templates for enterprise applications, lots of awesome features. It helps you build a large complex Single-Page Applications. I believe whatever your needs are, this project will help you.
Pan's avatar
refine    
Pan committed
30

花裤衩's avatar
花裤衩 committed
31
- [Preview](http://panjiachen.github.io/vue-element-admin)
Pan's avatar
Pan committed
32

Pan's avatar
Pan committed
33
- [Documentation](https://panjiachen.github.io/vue-element-admin-site/)
Pan's avatar
refine    
Pan committed
34

Pan's avatar
Pan committed
35
36
- [Gitter](https://gitter.im/vue-element-admin/discuss)

Pan's avatar
Pan committed
37
- [Wiki](https://github.com/PanJiaChen/vue-element-admin/wiki)
Pan's avatar
Pan committed
38

Pan's avatar
Pan committed
39
- [Donate](https://panjiachen.github.io/vue-element-admin-site/donate/)
花裤衩's avatar
花裤衩 committed
40

Pan's avatar
Pan committed
41
42
- [Gitee](https://panjiachen.gitee.io/vue-element-admin/) 国内用户可访问该地址在线预览

Pan's avatar
Pan committed
43
**This project is positioned as a background integration solution and is not suitable for secondary development as a basic template.**
ttop5's avatar
ttop5 committed
44

花裤衩's avatar
花裤衩 committed
45
46
 - Base template recommends using: [vueAdmin-template](https://github.com/PanJiaChen/vueAdmin-template)  
 - Desktop: [electron-vue-admin](https://github.com/PanJiaChen/electron-vue-admin)
Pan's avatar
Pan committed
47

花裤衩's avatar
花裤衩 committed
48
## Preparation
Pan's avatar
Pan committed
49

Pan's avatar
Pan committed
50
51
You need to install [node](http://nodejs.org/) and [git](https://git-scm.com/) locally. The project is based on [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/), [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).
 Understanding and learning this knowledge in advance will greatly help the use of this project.
Pan's avatar
Pan committed
52

花裤衩's avatar
花裤衩 committed
53
 **This project does not support low version browsers (e.g. IE). Please add polyfill yourself if you need them.**
Pan's avatar
Pan committed
54

Pan's avatar
Pan committed
55
56
 **Note: This project uses element-ui@2.3.0+ version, so the minimum compatible vue@2.5.0+**

57
58
59
 <p align="center">
  <img width="900" src="https://wpimg.wallstcn.com/a5894c1b-f6af-456e-82df-1151da0839bf.png">
</p>
Pan's avatar
refine    
Pan committed
60

花裤衩's avatar
花裤衩 committed
61
62
63
## Features
```
- Login / Logout
Pan's avatar
Pan committed
64
65
66
67
68
69

- Permission Authentication
  - Page permission
  - Directive permission
  - Two-step login

花裤衩's avatar
花裤衩 committed
70
- Multi-environment build
Pan's avatar
Pan committed
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
  - dev sit stage prod

- Global Features
  - I18n
  - Multiple dynamic themes
  - Dynamic sidebar (supports multi-level routing)
  - Dynamic breadcrumb
  - Tags-view(Tab page Support right-click operation)
  - Svg Sprite
  - Mock data
  - Screenfull
  - Responsive Sidebar

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

- Excel
  - Export Excel
  - Export zip
  - Upload Excel
  - Visualization Excel

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

- Error Page
  - 401
  - 404

- Components
  - Avatar Upload
  - Back To Top
  - Drag Dialog
  - Drag Kanban
  - Drag List
  - SplitPane
  - Dropzone
  - Sticky
  - CountTo

- Advanced Example
- Error Log
Pan's avatar
Pan committed
118
- Dashboard
花裤衩's avatar
花裤衩 committed
119
- Guide Page
花裤衩's avatar
花裤衩 committed
120
121
- Echarts
- Clipboard
122
- Markdown to html
花裤衩's avatar
花裤衩 committed
123
124
125
```

## Getting started
Pan's avatar
refine    
Pan committed
126

Pan's avatar
refine    
Pan committed
127
```bash
Pan's avatar
Pan committed
128
# clone the project
花裤衩's avatar
花裤衩 committed
129
git clone https://github.com/PanJiaChen/vue-element-admin.git
Pan's avatar
refine    
Pan committed
130

花裤衩's avatar
花裤衩 committed
131
132
# install dependency
npm install
Pan's avatar
refine    
Pan committed
133

花裤衩's avatar
花裤衩 committed
134
135
# develop
npm run dev
Pan's avatar
refine    
Pan committed
136
```
Pan's avatar
refine    
Pan committed
137

花裤衩's avatar
花裤衩 committed
138
139
140
This will automatically open http://localhost:9527.

## Build
Pan's avatar
Pan committed
141
```bash
花裤衩's avatar
花裤衩 committed
142
143
# build for test environment
npm run build:sit
144

花裤衩's avatar
花裤衩 committed
145
146
# build for production environment
npm run build:prod
147
148
```

花裤衩's avatar
花裤衩 committed
149
## Advanced
150
```bash
花裤衩's avatar
花裤衩 committed
151
152
# --report to build with bundle size analytics
npm run build:prod --report
Pan's avatar
refine    
Pan committed
153

花裤衩's avatar
花裤衩 committed
154
155
156
# --generate a bundle size analytics. default: bundle-report.html
npm run build:prod --generate_report

花裤衩's avatar
花裤衩 committed
157
158
# --preview to start a server in local to preview
npm run build:prod --preview
Pan's avatar
Pan committed
159

花裤衩's avatar
花裤衩 committed
160
161
# lint code
npm run lint
Pan's avatar
refine    
Pan committed
162

花裤衩's avatar
花裤衩 committed
163
164
# auto fix
npm run lint -- --fix
Pan's avatar
refine    
Pan committed
165
166
```

Pan's avatar
Pan committed
167
Refer to [Documentation](https://panjiachen.github.io/vue-element-admin-site/guide/essentials/deploy.html) for more information
花裤衩's avatar
花裤衩 committed
168

Pan's avatar
Pan committed
169
170
171
## Changelog
Detailed changes for each release are documented in the [release notes](https://github.com/PanJiaChen/vue-element-admin/releases).

172
## Online Demo
花裤衩's avatar
花裤衩 committed
173
[Preview](http://panjiachen.github.io/vue-element-admin)
Pan's avatar
Pan committed
174
175

## Donate
花裤衩's avatar
花裤衩 committed
176
177
178
179
180
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)
花裤衩's avatar
花裤衩 committed
181

花裤衩's avatar
花裤衩 committed
182
183
[Buy me a coffee](https://www.buymeacoffee.com/Pan)

花裤衩's avatar
花裤衩 committed
184
185
## License

花裤衩's avatar
花裤衩 committed
186
187
[MIT](https://github.com/PanJiaChen/vue-element-admin/blob/master/LICENSE)

Pan's avatar
Pan committed
188
Copyright (c) 2017-present PanJiaChen