README.md 3.42 KB
Newer Older
1
# vue-admin-template
Pan's avatar
Pan committed
2

Pan's avatar
Pan committed
3
English | [简体中文](./README-zh.md)
花裤衩's avatar
花裤衩 committed
4

Pan's avatar
Pan committed
5
> A minimal vue admin template with Element UI & axios & iconfont & permission control & lint
Pan's avatar
Pan committed
6

7
**Live demo:** http://panjiachen.github.io/vue-admin-template
Pan's avatar
Pan committed
8

花裤衩's avatar
花裤衩 committed
9

Pan's avatar
Pan committed
10
**The current version is `v4.0+` build on `vue-cli`. If you want to use the old version , you can switch branch to [tag/3.11.0](https://github.com/PanJiaChen/vue-admin-template/tree/tag/3.11.0), it does not rely on `vue-cli`**
Pan's avatar
Pan committed
11

花裤衩's avatar
花裤衩 committed
12 13 14 15 16 17 18 19 20
<p align="center">
  <b>SPONSORED BY</b>
</p>
<p align="center">
   <a href="https://finclip.com?from=vue_element" title="FinClip" target="_blank">
      <img height="200px" src="https://gitee.com/panjiachen/gitee-cdn/raw/master/vue%E8%B5%9E%E5%8A%A9.png" title="FinClip">
   </a>
</p>

花裤衩's avatar
花裤衩 committed
21
## Build Setup
花裤衩's avatar
花裤衩 committed
22

23
```bash
花裤衩's avatar
花裤衩 committed
24
# clone the project
Pan's avatar
Pan committed
25
git clone https://github.com/PanJiaChen/vue-admin-template.git
花裤衩's avatar
花裤衩 committed
26 27

# enter the project directory
Pan's avatar
Pan committed
28
cd vue-admin-template
Pan's avatar
Pan committed
29

花裤衩's avatar
花裤衩 committed
30
# install dependency
Pan's avatar
Pan committed
31 32
npm install

花裤衩's avatar
花裤衩 committed
33
# develop
Pan's avatar
Pan committed
34
npm run dev
花裤衩's avatar
花裤衩 committed
35 36
```

37
This will automatically open http://localhost:9528
花裤衩's avatar
花裤衩 committed
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56

## Build

```bash
# build for test environment
npm run build:stage

# build for production environment
npm run build:prod
```

## Advanced

```bash
# preview the release environment effect
npm run preview

# preview the release environment effect + static resource analysis
npm run preview -- --report
Pan's avatar
Pan committed
57

花裤衩's avatar
花裤衩 committed
58 59
# code format check
npm run lint
Pan's avatar
Pan committed
60

花裤衩's avatar
花裤衩 committed
61 62
# code format check and auto fix
npm run lint -- --fix
Pan's avatar
Pan committed
63 64
```

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

Pan's avatar
Pan committed
67
## Demo
68

Pan's avatar
Pan committed
69
![demo](https://github.com/PanJiaChen/PanJiaChen.github.io/blob/master/images/demo.gif)
Pan's avatar
Pan committed
70

Pan's avatar
Pan committed
71
## Extra
72

Pan's avatar
Pan committed
73
If you want router permission && generate menu by user roles , you can use this branch [permission-control](https://github.com/PanJiaChen/vue-admin-template/tree/permission-control)
Pan's avatar
Pan committed
74

75 76
For `typescript` version, you can use [vue-typescript-admin-template](https://github.com/Armour/vue-typescript-admin-template) (Credits: [@Armour](https://github.com/Armour))

Pan's avatar
Pan committed
77 78
## Related Project

花裤衩's avatar
花裤衩 committed
79
- [vue-element-admin](https://github.com/PanJiaChen/vue-element-admin)
80

花裤衩's avatar
花裤衩 committed
81
- [electron-vue-admin](https://github.com/PanJiaChen/electron-vue-admin)
Pan's avatar
Pan committed
82

花裤衩's avatar
花裤衩 committed
83 84 85
- [vue-typescript-admin-template](https://github.com/Armour/vue-typescript-admin-template)

- [awesome-project](https://github.com/PanJiaChen/vue-element-admin/issues/2312)
86

Pan's avatar
Pan committed
87 88 89 90 91 92 93 94
## 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" />](http://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" />](http://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" />](http://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" />](http://godban.github.io/browsers-support-badges/)</br>Safari |
| --------- | --------- | --------- | --------- |
| IE10, IE11, Edge| last 2 versions| last 2 versions| last 2 versions

Pan's avatar
Pan committed
95
## License
96

Pan's avatar
Pan committed
97
[MIT](https://github.com/PanJiaChen/vue-admin-template/blob/master/LICENSE) license.
Pan's avatar
Pan committed
98 99

Copyright (c) 2017-present PanJiaChen