2017-11-21 08:10:22 +00:00
< p align = "center" >
2017-11-21 08:15:34 +00:00
< img width = "320" src = "https://wpimg.wallstcn.com/ecc53a42-d79b-42e2-8852-5126b810a4c8.svg" >
2017-11-21 08:10:22 +00:00
< / p >
2017-12-29 08:07:42 +00:00
< p align = "center" >
2018-03-20 09:21:39 +00:00
< a href = "https://github.com/vuejs/vue" >
2019-04-01 09:07:16 +00:00
< img src = "https://img.shields.io/badge/vue-2.6.10-brightgreen.svg" alt = "vue" >
2018-03-20 09:21:39 +00:00
< / a >
< a href = "https://github.com/ElemeFE/element" >
2019-04-01 09:07:16 +00:00
< img src = "https://img.shields.io/badge/element--ui-2.7.0-brightgreen.svg" alt = "element-ui" >
2018-03-20 09:21:39 +00:00
< / 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 >
2018-08-26 08:01:52 +00:00
< 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 >
2017-12-29 08:07:42 +00:00
< / p >
2017-07-31 06:45:32 +00:00
2019-05-14 03:04:03 +00:00
English | [简体中文 ](./README.zh-CN.md ) | [日本語 ](./README.ja.md ) | [Spanish ](./README.es.md )
2017-07-31 06:45:32 +00:00
2017-12-29 08:07:42 +00:00
## Introduction
2017-07-31 06:45:32 +00:00
2019-10-14 02:25:30 +00:00
[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 ).
2018-06-25 06:54:02 +00:00
2019-10-14 02:25:30 +00:00
[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.
2017-04-25 05:53:49 +00:00
2019-04-11 01:42:44 +00:00
- [Preview ](https://panjiachen.github.io/vue-element-admin )
2017-05-12 05:56:22 +00:00
2018-06-25 06:54:02 +00:00
- [Documentation ](https://panjiachen.github.io/vue-element-admin-site/ )
2017-05-16 03:08:17 +00:00
2018-04-16 10:09:53 +00:00
- [Gitter ](https://gitter.im/vue-element-admin/discuss )
2018-06-25 06:54:02 +00:00
- [Donate ](https://panjiachen.github.io/vue-element-admin-site/donate/ )
2017-07-19 08:23:40 +00:00
2019-04-01 09:07:16 +00:00
- [Wiki ](https://github.com/PanJiaChen/vue-element-admin/wiki )
2018-07-31 03:26:45 +00:00
2019-04-01 09:07:16 +00:00
- [Gitee ](https://panjiachen.gitee.io/vue-element-admin/ ) 国内用户可访问该地址在线预览
2017-07-07 03:12:49 +00:00
2018-08-16 03:15:25 +00:00
- Base template recommends using: [vue-admin-template ](https://github.com/PanJiaChen/vue-admin-template )
2018-08-15 07:48:30 +00:00
- Desktop: [electron-vue-admin ](https://github.com/PanJiaChen/electron-vue-admin )
2018-09-06 09:38:11 +00:00
- Typescript: [vue-typescript-admin-template ](https://github.com/Armour/vue-typescript-admin-template ) (Credits: [@Armour ](https://github.com/Armour ))
2019-09-22 10:40:28 +00:00
- [awesome-project ](https://github.com/PanJiaChen/vue-element-admin/issues/2312 )
2018-08-15 07:48:30 +00:00
2019-05-05 08:49:40 +00:00
**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` **
2018-08-15 07:48:30 +00:00
2019-04-01 09:07:16 +00:00
**This project does not support low version browsers (e.g. IE). Please add polyfill by yourself.**
2017-04-25 06:29:48 +00:00
2017-12-29 08:07:42 +00:00
## Preparation
2017-09-11 02:56:28 +00:00
2019-04-11 01:42:44 +00:00
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 ).
2018-08-15 07:48:30 +00:00
Understanding and learning this knowledge in advance will greatly help the use of this project.
2017-06-14 10:02:12 +00:00
2020-05-04 15:05:29 +00:00
[![Edit on CodeSandbox ](https://codesandbox.io/static/img/play-codesandbox.svg )](https://codesandbox.io/s/github/PanJiaChen/vue-element-admin/tree/CodeSandbox)
2017-12-15 06:07:55 +00:00
< p align = "center" >
< img width = "900" src = "https://wpimg.wallstcn.com/a5894c1b-f6af-456e-82df-1151da0839bf.png" >
< / p >
2017-04-25 05:53:49 +00:00
2018-11-21 04:36:20 +00:00
## Sponsors
2019-04-01 09:07:16 +00:00
2018-11-21 04:36:20 +00:00
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 >
2017-12-29 08:07:42 +00:00
## Features
2018-08-15 07:48:30 +00:00
2017-12-29 08:07:42 +00:00
```
- Login / Logout
2018-06-25 06:54:02 +00:00
- Permission Authentication
- Page permission
- Directive permission
2019-04-01 09:07:16 +00:00
- Permission configuration page
2018-06-25 06:54:02 +00:00
- Two-step login
2017-12-29 08:07:42 +00:00
- Multi-environment build
2018-06-25 06:54:02 +00:00
- dev sit stage prod
- Global Features
- I18n
- Multiple dynamic themes
- Dynamic sidebar (supports multi-level routing)
- Dynamic breadcrumb
2019-01-10 02:05:17 +00:00
- Tags-view (Tab page Support right-click operation)
2018-06-25 06:54:02 +00:00
- Svg Sprite
- Mock data
- Screenfull
- Responsive Sidebar
- Editor
- Rich Text Editor
- Markdown Editor
- JSON Editor
- Excel
- Export Excel
- Upload Excel
- Visualization Excel
2019-04-01 09:07:16 +00:00
- Export zip
2018-06-25 06:54:02 +00:00
- Table
- Dynamic Table
- Drag And Drop Table
- Inline Edit Table
- Error Page
- 401
- 404
- Components
- Avatar Upload
- Back To Top
- Drag Dialog
2018-10-24 08:06:24 +00:00
- Drag Select
2018-06-25 06:54:02 +00:00
- Drag Kanban
- Drag List
- SplitPane
- Dropzone
- Sticky
- CountTo
- Advanced Example
- Error Log
2017-11-29 02:33:39 +00:00
- Dashboard
2018-05-28 06:36:06 +00:00
- Guide Page
2018-09-03 07:03:00 +00:00
- ECharts
2017-12-29 08:07:42 +00:00
- Clipboard
2017-12-15 06:07:55 +00:00
- Markdown to html
2017-12-29 08:07:42 +00:00
```
## Getting started
2017-04-25 05:53:49 +00:00
2017-04-24 09:04:40 +00:00
```bash
2018-02-06 10:46:47 +00:00
# clone the project
2017-12-29 08:07:42 +00:00
git clone https://github.com/PanJiaChen/vue-element-admin.git
2017-04-25 05:53:49 +00:00
2019-04-01 09:07:16 +00:00
# enter the project directory
cd vue-element-admin
2017-12-29 08:07:42 +00:00
# install dependency
npm install
2017-04-25 05:53:49 +00:00
2017-12-29 08:07:42 +00:00
# develop
npm run dev
2017-04-24 09:04:40 +00:00
```
2017-04-25 05:53:49 +00:00
2019-04-01 09:07:16 +00:00
This will automatically open http://localhost:9527
2017-12-29 08:07:42 +00:00
## Build
2018-08-15 07:48:30 +00:00
2017-04-24 10:19:35 +00:00
```bash
2017-12-29 08:07:42 +00:00
# build for test environment
2019-04-01 09:07:16 +00:00
npm run build:stage
2017-12-15 06:07:55 +00:00
2017-12-29 08:07:42 +00:00
# build for production environment
npm run build:prod
2017-12-15 06:07:55 +00:00
```
2017-12-29 08:07:42 +00:00
## Advanced
2018-08-15 07:48:30 +00:00
2017-12-15 06:07:55 +00:00
```bash
2019-04-01 09:07:16 +00:00
# preview the release environment effect
npm run preview
2018-08-15 07:33:34 +00:00
2019-04-01 09:07:16 +00:00
# preview the release environment effect + static resource analysis
npm run preview -- --report
2017-04-24 10:19:35 +00:00
2019-04-01 09:07:16 +00:00
# code format check
2017-12-29 08:07:42 +00:00
npm run lint
2017-04-25 05:53:49 +00:00
2019-04-01 09:07:16 +00:00
# code format check and auto fix
2017-12-29 08:07:42 +00:00
npm run lint -- --fix
2017-04-25 05:53:49 +00:00
```
2018-06-25 06:54:02 +00:00
Refer to [Documentation ](https://panjiachen.github.io/vue-element-admin-site/guide/essentials/deploy.html ) for more information
2017-12-29 08:07:42 +00:00
2017-05-31 10:28:06 +00:00
## Changelog
2018-08-15 07:48:30 +00:00
2017-05-31 10:28:06 +00:00
Detailed changes for each release are documented in the [release notes ](https://github.com/PanJiaChen/vue-element-admin/releases ).
2017-12-15 06:07:55 +00:00
## Online Demo
2018-08-15 07:48:30 +00:00
2019-04-11 01:42:44 +00:00
[Preview ](https://panjiachen.github.io/vue-element-admin )
2017-11-29 02:33:39 +00:00
## Donate
2018-08-15 07:48:30 +00:00
2017-12-29 08:07:42 +00:00
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 )
2017-07-19 08:23:40 +00:00
2018-03-01 02:41:09 +00:00
[Buy me a coffee ](https://www.buymeacoffee.com/Pan )
2018-10-15 09:21:17 +00:00
## Browsers support
Modern browsers and Internet Explorer 10+.
2019-04-11 01:42:44 +00:00
| [<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 |
2018-10-15 09:21:17 +00:00
| --------- | --------- | --------- | --------- |
| IE10, IE11, Edge| last 2 versions| last 2 versions| last 2 versions
2017-07-19 08:23:40 +00:00
## License
2017-12-29 08:07:42 +00:00
[MIT ](https://github.com/PanJiaChen/vue-element-admin/blob/master/LICENSE )
2017-12-29 08:11:20 +00:00
Copyright (c) 2017-present PanJiaChen