Skip to content
Snippets Groups Projects
README.md 7.35 KiB
Newer Older
  • Learn to ignore specific revisions
  • 花裤衩's avatar
    花裤衩 committed
    <p align="center">
    
    花裤衩's avatar
    花裤衩 committed
      <img width="320" src="https://wpimg.wallstcn.com/ecc53a42-d79b-42e2-8852-5126b810a4c8.svg">
    
    花裤衩's avatar
    花裤衩 committed
    </p>
    
    # vue-element-admin 
    
    花裤衩's avatar
    花裤衩 committed
    
    [![vue](https://img.shields.io/badge/vue-2.4.2-brightgreen.svg)](https://github.com/vuejs/vue)
    
    Pan's avatar
    Pan committed
    [![element-ui](https://img.shields.io/badge/element--ui-1.4.2-brightgreen.svg)](https://github.com/ElemeFE/element)
    
    花裤衩's avatar
    花裤衩 committed
    [![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)]()
    
    
    
    Pan's avatar
    Pan committed
    [线上地址](http://panjiachen.github.io/vue-element-admin)
    
    
    Pan's avatar
    Pan committed
    [English Document](https://github.com/PanJiaChen/vue-element-admin/blob/master/README-en.md)
    
    
    Pan's avatar
    Pan committed
    [wiki](https://github.com/PanJiaChen/vue-element-admin/wiki)
    
    
    Pan's avatar
    Pan committed
    [donate](https://github.com/PanJiaChen/vue-element-admin#donate)
    
    花裤衩's avatar
    花裤衩 committed
    
    
    Pan's avatar
    Pan committed
    **本项目的定位是后台集成方案,不适合当基础模板来开发。**
     - 模板建议使用: [vueAdmin-template](https://github.com/PanJiaChen/vueAdmin-template)  
     - 桌面端: [electron-vue-admin](https://github.com/PanJiaChen/electron-vue-admin)
    
    花裤衩's avatar
    花裤衩 committed
    
    
    花裤衩's avatar
    花裤衩 committed
    
    
    Pan's avatar
    Pan committed
    
    **注意:该项目目前使用element-ui@1.4.2版本,所以最低兼容 Vue 2.3.0**
    
    Pan's avatar
    Pan committed
    
    
    Pan's avatar
    Pan committed
    ## 前言
    
    ttop5's avatar
    ttop5 committed
    > 这半年来一直在用vue写管理后台,目前后台已经有百来个页面,十几种权限,但维护成本依然很低,所以准备开源分享一下后台开发的经验和成果。目前的技术栈主要的采用vue+element+axios由webpack2打包。由于是个人项目,所以数据请求都是用了mockjs模拟。注意:在此项目基础上改造开发时请移除mock文件。
    
    
    Pan's avatar
    Pan committed
    
    
    Pan's avatar
    Pan committed
    写了一个系列的教程配套文章,如何从零构建后一个完整的后台项目:
    
    Pan's avatar
    Pan committed
    
    
    Pan's avatar
    Pan committed
     - [wiki](https://github.com/PanJiaChen/vue-element-admin/wiki)
    
    Pan's avatar
    Pan committed
     - [手摸手,带你用 vue 撸后台 系列一(基础篇)](https://juejin.im/post/59097cd7a22b9d0065fb61d2)
     - [手摸手,带你用 vue 撸后台 系列二(登录权限篇)](https://juejin.im/post/591aa14f570c35006961acac)
    
    Pan's avatar
    Pan committed
     - [手摸手,带你用 vue 撸后台 系列三 (实战篇)](https://juejin.im/post/593121aa0ce4630057f70d35)
    
    花裤衩's avatar
    花裤衩 committed
     - [手摸手,带你用vue撸后台 系列四(vueAdmin 一个极简的后台基础模板)](https://juejin.im/post/595b4d776fb9a06bbe7dba56)
    
    Pan's avatar
    Pan committed
     - [手摸手,带你封装一个vue component](https://segmentfault.com/a/1190000009090836)
    
    Pan's avatar
    Pan committed
    
    
    ttop5's avatar
    ttop5 committed
     相应需求,开了一个qq群 `591724180` 方便大家交流
    
    Pan's avatar
    Pan committed
    
    
    花裤衩's avatar
    花裤衩 committed
     或者可以加入该 **[圈子](https://jianshiapp.com/circles/1209)** 讨论问题
    
    Pan's avatar
    Pan committed
    
    
    Pan's avatar
    Pan committed
     **如有问题请先看上述文章和Wiki,若不能满足,欢迎 issue 和 pr**
    
    Pan's avatar
    Pan committed
    
    
    ttop5's avatar
    ttop5 committed
     **该项目并不是一个脚手架,更倾向于是一个集成解决方案**
    
    Pan's avatar
    Pan committed
    
    
    Pan's avatar
    Pan committed
     **该项目不支持低版本游览器(如ie),有需求请自行添加polyfill [详情](https://github.com/PanJiaChen/vue-element-admin/wiki#babel-polyfill)**
    
    Pan's avatar
    Pan committed
    
    
    Pan's avatar
    Pan committed
    
    ## 功能
    - 登录/注销
    - 权限验证
    - 侧边栏
    - 面包屑
    - 富文本编辑器
    - Markdown编辑器
    - JSON编辑器
    - 列表拖拽
    - plitPane
    - Dropzone
    - Sticky
    - CountTo
    - echarts图表
    
    Pan's avatar
    Pan committed
    - 401,404错误页面
    
    Pan's avatar
    Pan committed
    - 错误日志
    - 导出excel
    
    Pan's avatar
    Pan committed
    - zip
    
    Pan's avatar
    Pan committed
    - 前端可视化excel
    
    Pan's avatar
    Pan committed
    - table example
    
    Pan's avatar
    Pan committed
    - 动态table example
    - 拖拽table example
    
    Pan's avatar
    Pan committed
    - 内联编辑table example
    
    Pan's avatar
    Pan committed
    - form example
    - 多环境发布
    - dashboard
    - 二次登录
    
    Pan's avatar
    Pan committed
    - 动态侧边栏(支持多级路由)
    
    Pan's avatar
    Pan committed
    - mock数据
    
    Pan's avatar
    Pan committed
    - cache tabs example
    - screenfull
    - markdown2html
    
    Pan's avatar
    Pan committed
    - views-tab
    
    Pan's avatar
    Pan committed
    - clipboard
    
    Pan's avatar
    Pan committed
    
    
    ## 开发
    
    Pan's avatar
    Pan committed
    ```bash
    
    Pan's avatar
    Pan committed
        # 克隆项目
    
    Pan's avatar
    Pan committed
        git clone https://github.com/PanJiaChen/vue-element-admin.git
    
    
    Pan's avatar
    Pan committed
        # 安装依赖
        npm install
    
    Pan's avatar
    Pan committed
        //or # 建议不要用cnpm  安装有各种诡异的bug 可以通过如下操作解决npm速度慢的问题
    
    Pan's avatar
    Pan committed
        npm install --registry=https://registry.npm.taobao.org
    
    Pan's avatar
    Pan committed
    
        # 本地开发 开启服务
    
    Pan's avatar
    Pan committed
        npm run dev
    
    Pan's avatar
    Pan committed
    ```
    
    Pan's avatar
    Pan committed
    浏览器访问 http://localhost:9527
    
    ## 发布
    
    Pan's avatar
    Pan committed
    ```bash
    
    Pan's avatar
    Pan committed
        # 发布测试环境 带webpack ananalyzer
        npm run build:sit-preview
    
    Pan's avatar
    Pan committed
    
    
    Pan's avatar
    Pan committed
        # 构建生成环境
        npm run build:prod
    
    Pan's avatar
    Pan committed
    ```
    
    
    Pan's avatar
    Pan committed
    ## 目录结构
    ```shell
    ├── build                      // 构建相关  
    ├── config                     // 配置相关
    ├── src                        // 源代码
    
    Pan's avatar
    Pan committed
    │   ├── api                    // 所有请求
    
    Pan's avatar
    Pan committed
    │   ├── assets                 // 主题 字体等静态资源
    │   ├── components             // 全局公用组件
    │   ├── directive              // 全局指令
    │   ├── filtres                // 全局filter
    │   ├── mock                   // mock数据
    │   ├── router                 // 路由
    │   ├── store                  // 全局store管理
    │   ├── styles                 // 全局样式
    │   ├── utils                  // 全局公用方法
    │   ├── view                   // view
    │   ├── App.vue                // 入口页面
    │   └── main.js                // 入口 加载组件 初始化等
    ├── static                     // 第三方不打包资源
    │   └── Tinymce                // 富文本
    ├── .babelrc                   // babel-loader 配置
    ├── eslintrc.js                // eslint 配置项
    ├── .gitignore                 // git 忽略项
    ├── favicon.ico                // favicon图标
    ├── index.html                 // html模板
    └── package.json               // package.json
    
    ```
    
    
    Pan's avatar
    Pan committed
    ## Changelog
    Detailed changes for each release are documented in the [release notes](https://github.com/PanJiaChen/vue-element-admin/releases).
    
    
    花裤衩's avatar
    花裤衩 committed
    ## Donate
    
    Pan's avatar
    Pan committed
    If you find this project useful, you can buy me a cup of coffee
    ![donate](https://panjiachen.github.io/donate/donation.png)
    
    花裤衩's avatar
    花裤衩 committed
    
    
    Pan's avatar
    Pan committed
    ## 状态管理
    后台只有user和app配置相关状态使用vuex存在全局,其它数据都由每个业务页面自己管理。
    
    
    
    Pan's avatar
    Pan committed
    ## 效果图
    
    Pan's avatar
    Pan committed
    
    
    Pan's avatar
    Pan committed
    #### 两步验证登录 支持微信和qq
    
    Pan's avatar
    Pan committed
    
    
    Pan's avatar
    Pan committed
    ![两步验证 here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/2login.gif)
    
    
    Pan's avatar
    Pan committed
    #### 真正的动态换肤
    
    Pan's avatar
    Pan committed
    
    
    Pan's avatar
    Pan committed
    ![真正的动态换肤](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/theme.gif)<br />
    
    
    Pan's avatar
    Pan committed
    #### tabs
    
    ![tabs](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/tabs.gif)<br />
    
    
    Pan's avatar
    Pan committed
    
    
    Pan's avatar
    Pan committed
    
    
    Pan's avatar
    Pan committed
    #### 可收起侧边栏
    
    Pan's avatar
    Pan committed
    
    
    Pan's avatar
    Pan committed
    ![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/leftmenu.gif)
    
    
    Pan's avatar
    Pan committed
    #### table拖拽排序
    
    Pan's avatar
    Pan committed
    
    
    Pan's avatar
    Pan committed
    ![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/order.gif)
    
    
    Pan's avatar
    Pan committed
    
    
    Pan's avatar
    Pan committed
    #### 动态table
    
    ![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/dynamictable.gif)
    
    
    Pan's avatar
    Pan committed
    
    
    Pan's avatar
    Pan committed
    #### 上传裁剪头像
    
    Pan's avatar
    Pan committed
    
    
    Pan's avatar
    Pan committed
    ![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/uploadAvatar.gif)
    
    
    Pan's avatar
    Pan committed
    
    
    Pan's avatar
    Pan committed
    #### 错误统计
    
    
    Pan's avatar
    Pan committed
    ![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/errorlog.gif)
    
    Pan's avatar
    Pan committed
    
    
    Pan's avatar
    Pan committed
    
    
    Pan's avatar
    Pan committed
    #### 富文本(整合七牛 打水印等个性化功能)
    
    Pan's avatar
    Pan committed
    
    
    Pan's avatar
    Pan committed
    ![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/editor.gif)
    
    
    Pan's avatar
    Pan committed
    #### 封装table组件
    
    Pan's avatar
    Pan committed
    
    
    Pan's avatar
    Pan committed
    ![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/table.gif)
    
    #### 图表
    
    Pan's avatar
    Pan committed
    
    
    Pan's avatar
    Pan committed
    ![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/echarts.gif)
    
    
    Pan's avatar
    Pan committed
    
    
    Pan's avatar
    Pan committed
    #### 导出excel
    
    Pan's avatar
    Pan committed
    
    
    Pan's avatar
    Pan committed
    ![enter image description here](https://github.com/PanJiaChen/vue-element-admin/blob/master/gifs/excel.png)
    
    
    Pan's avatar
    Pan committed
    
    
    花裤衩's avatar
    花裤衩 committed
    ## [查看更多demo](http://panjiachen.github.io/vue-element-admin)
    
    ## License
    
    MIT