English | [简体中文](./README.zh-CN.md)
## Introduction
-`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.
+[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).
+
+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.
- [Preview](http://panjiachen.github.io/vue-element-admin)
-- [Documentation](https://panjiachen.github.io/vue-element-admin-site/#/)
+- [Documentation](https://panjiachen.github.io/vue-element-admin-site/)
-- [wiki](https://github.com/PanJiaChen/vue-element-admin/wiki)
+- [Gitter](https://gitter.im/vue-element-admin/discuss)
-- [donate](https://panjiachen.github.io/vue-element-admin-site/#/donate)
+- [Wiki](https://github.com/PanJiaChen/vue-element-admin/wiki)
-**vue-element-admin is a admin interfaces integration solution, which is not suitable for secondary development as a base template.**
+- [Donate](https://panjiachen.github.io/vue-element-admin-site/donate/)
+
+- [Gitee](https://panjiachen.gitee.io/vue-element-admin/) 国内用户可访问该地址在线预览
+
+**This project is positioned as a background integration solution and is not suitable for secondary development as a basic template.**
- Base template recommends using: [vueAdmin-template](https://github.com/PanJiaChen/vueAdmin-template)
- Desktop: [electron-vue-admin](https://github.com/PanJiaChen/electron-vue-admin)
-**Note: This project uses element-ui@2.0.0+ version, so the minimum compatible vue@2.5.0**
-
## Preparation
-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.
-
- **This project is not a scaffolding and is more of an integrated solution.**
+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.
**This project does not support low version browsers (e.g. IE). Please add polyfill yourself if you need them.**
+ **Note: This project uses element-ui@2.3.0+ version, so the minimum compatible vue@2.5.0+**
+
@@ -56,45 +61,71 @@ You need to install [node](http://nodejs.org/) and [git](https://git-scm.com/) l
## Features
```
- Login / Logout
-- Permission authentication
+
+- Permission Authentication
+ - Page permission
+ - Directive permission
+ - Two-step login
+
- 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
+ - 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
- Dashboard
-- Mock data
+- Guide Page
- Echarts
- Clipboard
-- 401/404 error page
-- Error log
-- Export excel
-- Export zip
-- Front-end visualization excel
-- Table example
-- Dynamictable example
-- Drag and drop table example
-- Inline edit table example
-- Form example
-- Two-step login
-- SplitPane
-- Dropzone
-- Sticky
-- CountTo
- Markdown to html
```
## Getting started
```bash
-# clone the projice
+# clone the project
git clone https://github.com/PanJiaChen/vue-element-admin.git
# install dependency
@@ -130,7 +161,7 @@ npm run lint
npm run lint -- --fix
```
-Refer to [Documentation](https://panjiachen.github.io/vue-element-admin-site/#/deploy) for more information
+Refer to [Documentation](https://panjiachen.github.io/vue-element-admin-site/guide/essentials/deploy.html) for more information
## Changelog
Detailed changes for each release are documented in the [release notes](https://github.com/PanJiaChen/vue-element-admin/releases).
@@ -145,6 +176,8 @@ If you find this project useful, you can buy author a glass of juice :tropical_d
[Paypal Me](https://www.paypal.me/panfree23)
+[Buy me a coffee](https://www.buymeacoffee.com/Pan)
+
## License
[MIT](https://github.com/PanJiaChen/vue-element-admin/blob/master/LICENSE)
diff --git a/README.zh-CN.md b/README.zh-CN.md
index ead8d63c..ef5251f5 100644
--- a/README.zh-CN.md
+++ b/README.zh-CN.md
@@ -3,46 +3,48 @@
+
+ Only
+ admin can see this
+
+
+ Only
+ editor can see this
+
+
+ Both
+ admin and
+ editor can see this
+
+
+
+
+ In some cases it is not suitable to use v-permission, such as element Tab component which can only be achieved by manually setting the v-if.
+ e.g.
+
+
+ Admin can see this
+ Editor can see this
+ Both admin or editor can see this
+
+