forked from AkkomaGang/admin-fe
Update README.md
This commit is contained in:
parent
2d72df3605
commit
a4f8e0b805
2 changed files with 29 additions and 27 deletions
36
README-en.md
36
README-en.md
|
@ -1,29 +1,19 @@
|
||||||
|
[![vue](https://img.shields.io/badge/vue-2.4.2-brightgreen.svg)](https://github.com/vuejs/vue)
|
||||||
|
[![element-ui](https://img.shields.io/badge/element--ui-1.4.2-brightgreen.svg)](https://github.com/ElemeFE/element)
|
||||||
|
[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/PanJiaChen/vue-element-admin/blob/master/LICENSE)
|
||||||
|
[![GitHub release](https://img.shields.io/github/release/PanJiaChen/vue-element-admin.svg)]()
|
||||||
|
|
||||||
## Intro
|
## Intro
|
||||||
|
|
||||||
> In the past half year, I have been building a backend for management dashboard using Vue. Though the backend has contained greater than 70 pages and over 10 permissions, it still takes insignificant effort to maintain the project. So I decide to make it open source so as to share my development experience and progress on backend. The tech stack is mainly [Vue.js](https://github.com/vuejs/vue)+[Element](https://github.com/ElemeFE/element)+[axios](https://github.com/mzabriskie/axios). Since it's a personal project, all data requests are simulated with [Mock.js](https://github.com/nuysoft/Mock). **Note:** if anyone wants to modify or develop based on this project, please remove the mock files.
|
> In the past half year, I have been building a backend for management dashboard using Vue. Though the backend has contained greater than 70 pages and over 10 permissions, it still takes insignificant effort to maintain the project. So I decide to make it open source so as to share my development experience and progress on backend. The tech stack is mainly [Vue.js](https://github.com/vuejs/vue)+[Element](https://github.com/ElemeFE/element)+[axios](https://github.com/mzabriskie/axios). Since it's a personal project, all data requests are simulated with [Mock.js](https://github.com/nuysoft/Mock). **Note:** if anyone wants to modify or develop based on this project, please remove the mock files.
|
||||||
|
|
||||||
**Live demo:** http://panjiachen.github.io/vue-element-admin
|
**Live demo:** http://panjiachen.github.io/vue-element-admin
|
||||||
|
|
||||||
**Note: element-ui@1.3.3 is used in the project, so vue 2.3.0+ is required.**
|
**Note: element-ui@1.4.2 is used in the project, so vue 2.3.0+ is required.**
|
||||||
|
|
||||||
More tutorials incoming. Including articles on:
|
- vueAdmin-template: [vueAdmin-template](https://github.com/PanJiaChen/vueAdmin-template)
|
||||||
|
- electron-vue-admin: [electron-vue-admin](https://github.com/PanJiaChen/electron-vue-admin)
|
||||||
- How to build structure of a backend dashboard project from scratch
|
- Donate:[donate](https://github.com/PanJiaChen/vue-element-admin/blob/master/README-en.md#donate)
|
||||||
- How to make a complete user system (e.g. permission authentication, two-factor authentication)
|
|
||||||
- How to package components (e.g. rich text)
|
|
||||||
- How to integrate with [Qiniu](https://www.qiniu.com/)
|
|
||||||
- Other development experience on backend
|
|
||||||
|
|
||||||
Join the group on QQ 591724180.
|
|
||||||
|
|
||||||
**Tutorials:**
|
|
||||||
|
|
||||||
- [Wiki](https://github.com/PanJiaChen/vue-element-admin/wiki)
|
|
||||||
- [Step by step instructions on playing with backend using Vue Part 1 - Fundamentals](https://juejin.im/post/59097cd7a22b9d0065fb61d2)
|
|
||||||
- [Step by step instructions on playing with backend using Vue Part 2 - Login permission](https://juejin.im/post/591aa14f570c35006961acac)
|
|
||||||
- [Step by step instructions on packaging a Vue component](https://segmentfault.com/a/1190000009090836)
|
|
||||||
|
|
||||||
**Please read the Wiki and articles above before creating any issue. Feel free to contribute by making a pull request.**
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
|
@ -117,6 +107,10 @@ npm run build:prod
|
||||||
## Changelog
|
## Changelog
|
||||||
Detailed changes for each release are documented in the [release notes](https://github.com/PanJiaChen/vue-element-admin/releases).
|
Detailed changes for each release are documented in the [release notes](https://github.com/PanJiaChen/vue-element-admin/releases).
|
||||||
|
|
||||||
|
## Donate
|
||||||
|
If you find this project useful, you can buy me a cup of coffee
|
||||||
|
![donate](https://panjiachen.github.io/donate/donation.png)
|
||||||
|
|
||||||
## State Management
|
## State Management
|
||||||
|
|
||||||
Only status of user and app configuration is managed by Vuex. Other data are managed by their own business pages.
|
Only status of user and app configuration is managed by Vuex. Other data are managed by their own business pages.
|
||||||
|
@ -174,3 +168,7 @@ Only status of user and app configuration is managed by Vuex. Other data are man
|
||||||
#### More
|
#### More
|
||||||
|
|
||||||
http://panjiachen.github.io/vue-element-admin
|
http://panjiachen.github.io/vue-element-admin
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
MIT
|
||||||
|
|
16
README.md
16
README.md
|
@ -1,7 +1,7 @@
|
||||||
# vue-element-admin #
|
# vue-element-admin #
|
||||||
|
|
||||||
[![vue](https://img.shields.io/badge/vue-2.4.2-brightgreen.svg)](https://github.com/vuejs/vue)
|
[![vue](https://img.shields.io/badge/vue-2.4.2-brightgreen.svg)](https://github.com/vuejs/vue)
|
||||||
[![element-ui](https://img.shields.io/badge/element--ui-1.4.1-brightgreen.svg)](https://github.com/ElemeFE/element)
|
[![element-ui](https://img.shields.io/badge/element--ui-1.4.2-brightgreen.svg)](https://github.com/ElemeFE/element)
|
||||||
[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/PanJiaChen/vue-element-admin/blob/master/LICENSE)
|
[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/PanJiaChen/vue-element-admin/blob/master/LICENSE)
|
||||||
[![GitHub release](https://img.shields.io/github/release/PanJiaChen/vue-element-admin.svg)]()
|
[![GitHub release](https://img.shields.io/github/release/PanJiaChen/vue-element-admin.svg)]()
|
||||||
|
|
||||||
|
@ -12,11 +12,15 @@
|
||||||
|
|
||||||
[wiki](https://github.com/PanJiaChen/vue-element-admin/wiki)
|
[wiki](https://github.com/PanJiaChen/vue-element-admin/wiki)
|
||||||
|
|
||||||
**本项目的定位是后台集成方案,不适合当基础模板来开发,模板建议使用 [vueAdmin-template](https://github.com/PanJiaChen/vueAdmin-template) , 桌面端 [electron-vue-admin](https://github.com/PanJiaChen/electron-vue-admin)**
|
[donate](https://github.com/PanJiaChen/vue-element-admin#donate)
|
||||||
|
|
||||||
|
**本项目的定位是后台集成方案,不适合当基础模板来开发。**
|
||||||
|
- 模板建议使用: [vueAdmin-template](https://github.com/PanJiaChen/vueAdmin-template)
|
||||||
|
- 桌面端: [electron-vue-admin](https://github.com/PanJiaChen/electron-vue-admin)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**注意:该项目目前使用element-ui@1.4.1版本,所以最低兼容 Vue 2.3.0**
|
**注意:该项目目前使用element-ui@1.4.2版本,所以最低兼容 Vue 2.3.0**
|
||||||
|
|
||||||
## 前言
|
## 前言
|
||||||
> 这半年来一直在用vue写管理后台,目前后台已经有百来个页面,十几种权限,但维护成本依然很低,所以准备开源分享一下后台开发的经验和成果。目前的技术栈主要的采用vue+element+axios由webpack2打包。由于是个人项目,所以数据请求都是用了mockjs模拟。注意:在此项目基础上改造开发时请移除mock文件。
|
> 这半年来一直在用vue写管理后台,目前后台已经有百来个页面,十几种权限,但维护成本依然很低,所以准备开源分享一下后台开发的经验和成果。目前的技术栈主要的采用vue+element+axios由webpack2打包。由于是个人项目,所以数据请求都是用了mockjs模拟。注意:在此项目基础上改造开发时请移除mock文件。
|
||||||
|
@ -35,11 +39,11 @@
|
||||||
|
|
||||||
或者可以加入该 **[圈子](https://jianshiapp.com/circles/1209)** 讨论问题
|
或者可以加入该 **[圈子](https://jianshiapp.com/circles/1209)** 讨论问题
|
||||||
|
|
||||||
**如有问题请先看上述文章和Wiki,若不能满足,欢迎 issue 和 pr ~**
|
**如有问题请先看上述文章和Wiki,若不能满足,欢迎 issue 和 pr**
|
||||||
|
|
||||||
**该项目并不是一个脚手架,更倾向于是一个集成解决方案**
|
**该项目并不是一个脚手架,更倾向于是一个集成解决方案**
|
||||||
|
|
||||||
**该项目不支持低版本游览器,有需求请自行添加polyfill [详情](https://github.com/PanJiaChen/vue-element-admin/wiki#babel-polyfill)**
|
**该项目不支持低版本游览器(如ie),有需求请自行添加polyfill [详情](https://github.com/PanJiaChen/vue-element-admin/wiki#babel-polyfill)**
|
||||||
|
|
||||||
|
|
||||||
## 功能
|
## 功能
|
||||||
|
@ -133,7 +137,7 @@ Detailed changes for each release are documented in the [release notes](https://
|
||||||
|
|
||||||
## Donate
|
## Donate
|
||||||
If you find this project useful, you can buy me a cup of coffee
|
If you find this project useful, you can buy me a cup of coffee
|
||||||
![donate](https://panjiachen.github.io/donate/donate.png)
|
![donate](https://panjiachen.github.io/donate/donation.png)
|
||||||
|
|
||||||
## 状态管理
|
## 状态管理
|
||||||
后台只有user和app配置相关状态使用vuex存在全局,其它数据都由每个业务页面自己管理。
|
后台只有user和app配置相关状态使用vuex存在全局,其它数据都由每个业务页面自己管理。
|
||||||
|
|
Loading…
Reference in a new issue