diff --git a/README-en.md b/README-en.md index cc4be12826c692c11a297501d1782d81f6a1a15d..6f9ffa0b50e069da2c71b701f6c5937da9e68305 100644 --- a/README-en.md +++ b/README-en.md @@ -1,29 +1,19 @@ +[](https://github.com/vuejs/vue) +[](https://github.com/ElemeFE/element) +[](https://github.com/PanJiaChen/vue-element-admin/blob/master/LICENSE) +[]() + ## 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.** - -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:** +**Note: element-ui@1.4.2 is used in the project, so vue 2.3.0+ is required.** -- [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 + + ## 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 1a05445650427c16d18580400978a48d72af942f..7e6135e804dedf031a78e751665a07b2aab94eb1 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # vue-element-admin # [](https://github.com/vuejs/vue) -[](https://github.com/ElemeFE/element) +[](https://github.com/ElemeFE/element) [](https://github.com/PanJiaChen/vue-element-admin/blob/master/LICENSE) []() @@ -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 - +If you find this project useful, you can buy me a cup of coffee + ## 状æ€ç®¡ç† åŽå°åªæœ‰userå’Œappé…置相关状æ€ä½¿ç”¨vuexå˜åœ¨å…¨å±€ï¼Œå…¶å®ƒæ•°æ®éƒ½ç”±æ¯ä¸ªä¸šåŠ¡é¡µé¢è‡ªå·±ç®¡ç†ã€‚