From a4f8e0b805837ebfe0771f983f70fe629d22cd39 Mon Sep 17 00:00:00 2001 From: Pan Date: Mon, 11 Sep 2017 10:56:28 +0800 Subject: [PATCH] Update README.md --- README-en.md | 36 +++++++++++++++++------------------- README.md | 20 ++++++++++++-------- 2 files changed, 29 insertions(+), 27 deletions(-) diff --git a/README-en.md b/README-en.md index cc4be128..6f9ffa0b 100644 --- a/README-en.md +++ b/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 > 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 -**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: - -- How to build structure of a backend dashboard project from scratch -- 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.** + - vueAdmin-template: [vueAdmin-template](https://github.com/PanJiaChen/vueAdmin-template)   + - electron-vue-admin: [electron-vue-admin](https://github.com/PanJiaChen/electron-vue-admin) + - Donate:[donate](https://github.com/PanJiaChen/vue-element-admin/blob/master/README-en.md#donate) ## Features @@ -117,6 +107,10 @@ npm run build:prod ## Changelog 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 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 http://panjiachen.github.io/vue-element-admin + +## License + +MIT diff --git a/README.md b/README.md index 1a054456..7e6135e8 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # vue-element-admin # [![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) [![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) -**本项目的定位是后台集成方案，不适合当基础模板来开发，模板建议使用 [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文件。 @@ -32,14 +36,14 @@ - [手摸手，带你封装一个vue component](https://segmentfault.com/a/1190000009090836) 相应需求，开了一个qq群 `591724180` 方便大家交流 - + 或者可以加入该 **[圈子](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)** ## 功能 @@ -132,8 +136,8 @@ 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/donate.png) +If you find this project useful, you can buy me a cup of coffee +![donate](https://panjiachen.github.io/donate/donation.png) ## 状态管理 后台只有user和app配置相关状态使用vuex存在全局，其它数据都由每个业务页面自己管理。