README.md 4.88 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
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<p align="center">
	<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">
		<img src="https://img.shields.io/badge/element--ui-2.0.8-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>
</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

花裤衩's avatar
花裤衩 committed
27
`vue-element-admin` is a production-ready solution for admin interfaces. Based on [Vue.js](https://github.com/vuejs/vue) and use the UI Toolkit -- [element](https://github.com/ElemeFE/element). `vue-element-admin` is a magical vue admin, it 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
28

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

花裤衩's avatar
花裤衩 committed
31
- [Documentation](https://panjiachen.github.io/vue-element-admin-site/#/)
Pan's avatar
refine    
Pan committed
32

Pan's avatar
Pan committed
33
34
35
- [wiki](https://github.com/PanJiaChen/vue-element-admin/wiki)

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

花裤衩's avatar
花裤衩 committed
37
**vue-element-admin is a admin interfaces integration solution, which is not suitable for secondary development as a base template.**
ttop5's avatar
ttop5 committed
38

花裤衩's avatar
花裤衩 committed
39
40
 - 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
41

花裤衩's avatar
花裤衩 committed
42
**Note: This project uses element-ui@2.0.0+ version, so the minimum compatible vue@2.5.0**
Pan's avatar
refine    
Pan committed
43

花裤衩's avatar
花裤衩 committed
44
## Preparation
Pan's avatar
Pan committed
45

花裤衩's avatar
花裤衩 committed
46
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/)[element-ui](https://github.com/ElemeFE/element). All data requests for this project are simulated using [Mock.js](https://github.com/nuysoft/Mock). It would be helpful if you have pre-existing knowledge on those.
Pan's avatar
Pan committed
47

花裤衩's avatar
花裤衩 committed
48
 **This project is not a scaffolding and is more of an integrated solution.**
Pan's avatar
Pan committed
49

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

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

花裤衩's avatar
花裤衩 committed
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
## Features
```
- Login / Logout
- Permission authentication
- Multi-environment build
- Dynamic sidebar (supports multi-level routing)
- Dynamic breadcrumb
- I18n
- Customizable theme
- Tags-view(Tab page Support right-click operation)
- Rich text editor
- Markdown editor
- JSON editor
- Screenfull
- Drag and drop list
- Svg Sprite
Pan's avatar
Pan committed
72
- Dashboard
花裤衩's avatar
花裤衩 committed
73
74
75
76
77
78
79
80
- Mock data
- Echarts
- Clipboard
- 401/404 error page
- Error log
- Export excel
- Export zip
- Front-end visualization excel
Pan's avatar
Pan committed
81
- Tree Table
Pan's avatar
Pan committed
82
- Table example
花裤衩's avatar
花裤衩 committed
83
84
85
- Dynamictable example
- Drag and drop table example
- Inline edit table example
Pan's avatar
Pan committed
86
- Form example
花裤衩's avatar
花裤衩 committed
87
- Two-step login
Pan's avatar
Pan committed
88
89
90
91
- SplitPane
- Dropzone
- Sticky
- CountTo
92
- Markdown to html
花裤衩's avatar
花裤衩 committed
93
94
95
```

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

Pan's avatar
refine    
Pan committed
97
```bash
Pan's avatar
Pan committed
98
# clone the project
花裤衩's avatar
花裤衩 committed
99
git clone https://github.com/PanJiaChen/vue-element-admin.git
Pan's avatar
refine    
Pan committed
100

花裤衩's avatar
花裤衩 committed
101
102
# install dependency
npm install
Pan's avatar
refine    
Pan committed
103

花裤衩's avatar
花裤衩 committed
104
105
# develop
npm run dev
Pan's avatar
refine    
Pan committed
106
```
Pan's avatar
refine    
Pan committed
107

花裤衩's avatar
花裤衩 committed
108
109
110
This will automatically open http://localhost:9527.

## Build
Pan's avatar
Pan committed
111
```bash
花裤衩's avatar
花裤衩 committed
112
113
# build for test environment
npm run build:sit
114

花裤衩's avatar
花裤衩 committed
115
116
# build for production environment
npm run build:prod
117
118
```

花裤衩's avatar
花裤衩 committed
119
## Advanced
120
```bash
花裤衩's avatar
花裤衩 committed
121
122
# --report to build with bundle size analytics
npm run build:prod --report
Pan's avatar
refine    
Pan committed
123

花裤衩's avatar
花裤衩 committed
124
125
# --preview to start a server in local to preview
npm run build:prod --preview
Pan's avatar
Pan committed
126

花裤衩's avatar
花裤衩 committed
127
128
# lint code
npm run lint
Pan's avatar
refine    
Pan committed
129

花裤衩's avatar
花裤衩 committed
130
131
# auto fix
npm run lint -- --fix
Pan's avatar
refine    
Pan committed
132
133
```

花裤衩's avatar
花裤衩 committed
134
135
Refer to [Documentation](https://panjiachen.github.io/vue-element-admin-site/#/deploy) for more information

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

139
## Online Demo
花裤衩's avatar
花裤衩 committed
140
[Preview](http://panjiachen.github.io/vue-element-admin)
Pan's avatar
Pan committed
141
142

## Donate
花裤衩's avatar
花裤衩 committed
143
144
145
146
147
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
148
149
150

## License

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

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