From 39d26068ec592df790e03f88c12e89593b797897 Mon Sep 17 00:00:00 2001 From: Pan <panfree23@gmail.com> Date: Wed, 29 Nov 2017 10:33:39 +0800 Subject: [PATCH] doc:update readme --- README.md | 155 ++++++++++++++++--------------------------------- build/utils.js | 2 +- 2 files changed, 52 insertions(+), 105 deletions(-) diff --git a/README.md b/README.md index 2d755830..1ece4537 100644 --- a/README.md +++ b/README.md @@ -2,39 +2,39 @@ <img width="320" src="https://wpimg.wallstcn.com/ecc53a42-d79b-42e2-8852-5126b810a4c8.svg"> </p> -# vue-element-admin +# vue-element-admin -[](https://github.com/vuejs/vue) -[](https://github.com/ElemeFE/element) +[](https://github.com/vuejs/vue) +[](https://github.com/ElemeFE/element) [](https://github.com/PanJiaChen/vue-element-admin/blob/master/LICENSE) []() +A magical vue admin. -[线上地å€](http://panjiachen.github.io/vue-element-admin) +- [线上地å€](http://panjiachen.github.io/vue-element-admin) -[English Document](https://github.com/PanJiaChen/vue-element-admin/blob/master/README-en.md) +- [文档地å€](https://panjiachen.github.io/vue-element-admin-site/#/) -[wiki](https://github.com/PanJiaChen/vue-element-admin/wiki) +- [English Document](https://github.com/PanJiaChen/vue-element-admin/blob/master/README-en.md) -[donate](https://github.com/PanJiaChen/vue-element-admin#donate) +- [wiki](https://github.com/PanJiaChen/vue-element-admin/wiki) + +- [donate](https://panjiachen.github.io/vue-element-admin-site/#/donate) **本项目的定ä½æ˜¯åŽå°é›†æˆæ–¹æ¡ˆï¼Œä¸é€‚åˆå½“基础模æ¿æ¥å¼€å‘。** - 模æ¿å»ºè®®ä½¿ç”¨: [vueAdmin-template](https://github.com/PanJiaChen/vueAdmin-template)  - æ¡Œé¢ç«¯: [electron-vue-admin](https://github.com/PanJiaChen/electron-vue-admin) - -**注æ„:该项目目å‰ä½¿ç”¨element-ui@1.4.2版本,所以最低兼容 Vue 2.3.0** +**注æ„:该项目目å‰ä½¿ç”¨element-ui@2.0.5版本,所以最低兼容 Vue 2.5.0** 楼主这里有一份调查[é—®å·](https://www.wjx.cn/m/16866569.aspx) 有空请填写一下,以表对本项目的支æŒ~ps:ä¸æ˜¯ç»™è¿™ä¸ªè°ƒæŸ¥é—®å·ç½‘ç«™åšå¹¿å‘Šï¼Œæ‰€ä»¥å¡«å®Œé—®å·ä¸ç”¨ç‚¹ä¸Šé¢æŠ½å¥–有的没的那些东西 -## å‰è¨€ -> è¿™åŠå¹´æ¥ä¸€ç›´åœ¨ç”¨vue写管ç†åŽå°ï¼Œç›®å‰åŽå°å·²ç»æœ‰ç™¾æ¥ä¸ªé¡µé¢ï¼Œåå‡ ç§æƒé™ï¼Œä½†ç»´æŠ¤æˆæœ¬ä¾ç„¶å¾ˆä½Žï¼Œæ‰€ä»¥å‡†å¤‡å¼€æºåˆ†äº«ä¸€ä¸‹åŽå°å¼€å‘çš„ç»éªŒå’Œæˆæžœã€‚ç›®å‰çš„æŠ€æœ¯æ ˆä¸»è¦çš„采用vue+element+axiosç”±webpack2打包。由于是个人项目,所以数æ®è¯·æ±‚都是用了mockjs模拟。注æ„:在æ¤é¡¹ç›®åŸºç¡€ä¸Šæ”¹é€ å¼€å‘时请移除mock文件。 +## å‰åºå‡†å¤‡ +ä½ çš„æœ¬åœ°çŽ¯å¢ƒéœ€è¦å®‰è£… [node](http://nodejs.org/) å’Œ [git](https://git-scm.com/)ã€‚æˆ‘ä»¬çš„æŠ€æœ¯æ ˆåŸºäºŽ [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),æå‰äº†è§£å’Œå¦ä¹ 这些知识会对使用本项目有很大的帮助。 -写了一个系列的教程é…å¥—æ–‡ç« ï¼Œå¦‚ä½•ä»Žé›¶æž„å»ºåŽä¸€ä¸ªå®Œæ•´çš„åŽå°é¡¹ç›®: - - - [wiki](https://github.com/PanJiaChen/vue-element-admin/wiki) +åŒæ—¶é…å¥—ä¸€ä¸ªç³»åˆ—çš„æ•™ç¨‹æ–‡ç« ï¼Œå¦‚ä½•ä»Žé›¶æž„å»ºåŽä¸€ä¸ªå®Œæ•´çš„åŽå°é¡¹ç›®ï¼Œå»ºè®®å¤§å®¶å…ˆçœ‹å®Œè¿™äº›æ–‡ç« å†æ¥å®žè·µæœ¬é¡¹ç›® - [æ‰‹æ‘¸æ‰‹ï¼Œå¸¦ä½ ç”¨ vue æ’¸åŽå° 系列一(基础篇)](https://juejin.im/post/59097cd7a22b9d0065fb61d2) - [æ‰‹æ‘¸æ‰‹ï¼Œå¸¦ä½ ç”¨ vue æ’¸åŽå° 系列二(登录æƒé™ç¯‡)](https://juejin.im/post/591aa14f570c35006961acac) - [æ‰‹æ‘¸æ‰‹ï¼Œå¸¦ä½ ç”¨ vue æ’¸åŽå° 系列三 (实战篇)](https://juejin.im/post/593121aa0ce4630057f70d35) @@ -47,7 +47,7 @@ **å¦‚æœ‰é—®é¢˜è¯·å…ˆçœ‹ä¸Šè¿°æ–‡ç« å’ŒWiki,若ä¸èƒ½æ»¡è¶³ï¼Œæ¬¢è¿Ž issue å’Œ pr** - **该项目并ä¸æ˜¯ä¸€ä¸ªè„šæ‰‹æž¶ï¼Œæ›´å€¾å‘于是一个集æˆè§£å†³æ–¹æ¡ˆ** + **本项目并ä¸æ˜¯ä¸€ä¸ªè„šæ‰‹æž¶ï¼Œæ›´å€¾å‘于是一个集æˆè§£å†³æ–¹æ¡ˆ** **该项目ä¸æ”¯æŒä½Žç‰ˆæœ¬æ¸¸è§ˆå™¨(如ie)ï¼Œæœ‰éœ€æ±‚è¯·è‡ªè¡Œæ·»åŠ polyfill [详情](https://github.com/PanJiaChen/vue-element-admin/wiki#babel-polyfill)** @@ -55,37 +55,38 @@ ## 功能 - 登录/注销 - æƒé™éªŒè¯ -- 侧边æ -- é¢åŒ…屑 +- 多环境å‘布 +- 动æ€ä¾§è¾¹æ (支æŒå¤šçº§è·¯ç”±ï¼‰ +- 动æ€é¢åŒ…屑 +- 国际化多è¯è¨€ +- 多ç§åŠ¨æ€æ¢è‚¤ +- å¿«æ·å¯¼èˆª(æ ‡ç¾é¡µ) - 富文本编辑器 - Markdown编辑器 - JSON编辑器 +- Screenfullå…¨å± - 列表拖拽 -- plitPane -- Dropzone -- Sticky -- CountTo -- echarts图表 -- 401,404é”™è¯¯é¡µé¢ +- Svg Sprite å›¾æ ‡ +- Dashboard +- 本地mockæ•°æ® +- Echarts 图表 +- Clipboard(剪贴å¤åˆ¶) +- 401/404é”™è¯¯é¡µé¢ - 错误日志 - 导出excel -- zip +- 导出zip - å‰ç«¯å¯è§†åŒ–excel -- table example +- Table example - 动æ€table example - 拖拽table example - 内è”编辑table example -- form example -- 多环境å‘布 -- dashboard -- 二次登录 -- 动æ€ä¾§è¾¹æ (支æŒå¤šçº§è·¯ç”±ï¼‰ -- mockæ•°æ® -- cache tabs example -- screenfull -- markdown2html -- views-tab -- clipboard +- Form example +- 二æ¥ç™»å½• +- SplitPane +- Dropzone +- Sticky +- CountTo +- Markdown2html ## å¼€å‘ @@ -121,15 +122,19 @@ │  ├── assets // 主题 å—体ç‰é™æ€èµ„æº â”‚Â Â â”œâ”€â”€ components // 全局公用组件 │  ├── directive // 全局指令 -│  ├── filtres // 全局filter -│  ├── mock // mockæ•°æ® +│  ├── filtres // 全局 filter +│  ├── icons // 项目所有 svg icons +│  ├── lang // 国际化 language +│  ├── mock // 项目mock æ¨¡æ‹Ÿæ•°æ® â”‚Â Â â”œâ”€â”€ router // 路由 -│  ├── store // 全局storeç®¡ç† +│  ├── store // 全局 storeç®¡ç† â”‚Â Â â”œâ”€â”€ styles // å…¨å±€æ ·å¼ â”‚Â Â â”œâ”€â”€ utils // 全局公用方法 -│  ├── view // view +│  ├── vendor // 公用vendor +│  ├── views // view │  ├── App.vue // å…¥å£é¡µé¢ -│  └── main.js // å…¥å£ åŠ è½½ç»„ä»¶ åˆå§‹åŒ–ç‰ +│  ├── main.js // å…¥å£ åŠ è½½ç»„ä»¶ åˆå§‹åŒ–ç‰ +│ └── permission.js // æƒé™ç®¡ç† ├── static // 第三方ä¸æ‰“åŒ…èµ„æº â”‚Â Â â””â”€â”€ Tinymce // 富文本 ├── .babelrc // babel-loader é…ç½® @@ -144,73 +149,15 @@ ## 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 - - ## 状æ€ç®¡ç† åŽå°åªæœ‰userå’Œappé…置相关状æ€ä½¿ç”¨vuexå˜åœ¨å…¨å±€ï¼Œå…¶å®ƒæ•°æ®éƒ½ç”±æ¯ä¸ªä¸šåŠ¡é¡µé¢è‡ªå·±ç®¡ç†ã€‚ - -## 效果图 - -#### 两æ¥éªŒè¯ç™»å½• 支æŒå¾®ä¿¡å’Œqq - - - -#### 真æ£çš„动æ€æ¢è‚¤ - -<br /> - -#### tabs - -<br /> - - - -#### å¯æ”¶èµ·ä¾§è¾¹æ - - - -#### tableæ‹–æ‹½æŽ’åº - - - - -#### 动æ€table - - - - -#### ä¸Šä¼ è£å‰ªå¤´åƒ - - - - -#### 错误统计 - - - - -#### 富文本(æ•´åˆä¸ƒç‰› 打水å°ç‰ä¸ªæ€§åŒ–功能) - - - -#### å°è£…table组件 - - - -#### 图表 - - - - -#### 导出excel - - - - ## [查看更多demo](http://panjiachen.github.io/vue-element-admin) + + +## Donate +If you find this project useful, you can buy me a cup of coffee + ## License diff --git a/build/utils.js b/build/utils.js index 06fe2563..685ccf59 100644 --- a/build/utils.js +++ b/build/utils.js @@ -23,7 +23,7 @@ exports.cssLoaders = function (options) { var postcssLoader = { loader: 'postcss-loader', options: { - sourceMap: options.sourceMap + sourceMap: true } } -- GitLab