# MTools-Admin

**Repository Path**: hjmeng/MTools-Admin

## Basic Information

- **Project Name**: MTools-Admin
- **Description**: MTools项目后台管理系统
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-01-19
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# MTools-Admin

#### 介绍
搭建实用的vue技术架构，包含webpack搭建指南与详解

#### 软件架构

```
.
├── build                            # 打包脚本
│   ├── lib                            # 提起打包静态资源(不改变的npm包提升打包效率)
│   ├── loader                         # loader文件
│   │   └── style-loader.js              # 样式处理
│   ├── webpack                        # webpack配置
│   │   ├── webpack.dll.conf.js          # 静态资源打包
│   │   ├── webpack.online.conf.js       # 上线环境配置(包括生产和测试)
│   │   ├── webpack.base.conf.js         # 基础配置
│   │   ├── webpack.dev.conf.js          # 本地开发
│   │   ├── webpack.prod.conf.js         # 生产环境
│   │   └── webpack.test.conf.js         # 测试环境
│   ├── paths.js                       # 路径处理
│   ├── utils.js                       # 打包工具库
│   └── build.js                       # 打包
├── config                           # 项目配置
│   ├── dev.js                         # 开发环境
│   ├── prod.js                        # 生产环境
│   ├── test.js                        # 测试环境
│   └── index.js                       # 配置入口
├── docs                             # 技术文档
├── public                          
├── src                              # 业务开发
|   ├── api                            # api方法
|   ├── assets                         # 本地静态资源
│   ├── components                     # 项目通用通用组件
│   ├── config                         # 业务配置文件
│   ├── directive                      # 自定义指令
│   ├── filters                        # 自定义过滤器
│   ├── plugins                        # 自定义插件
│   ├── routers                        # 路由入口
│   ├── services                       # 服务封装
│   ├── store                          # vuex存储
│   ├── views                          # 业务页面
│   ├── utils                          # 工具库,公共js文件
│   ├── styles                         # 公共样式
│   ├── main.js                        # 应用入口
│   ├── permission.js                  # 权限配置
│   └── App.vue                        # 路由入口
├── .babelrc.js                      # babel配置文件
├── .eslintignore                    # eslint排除处理文件
├── .eslintrc.js                     # eslint配置文件
├── .stylelintignore                 # stylelint排除处理文件
├── .stylelintrc.js                  # stylelint配置文件
├── .prettierrc.js                   # prettier配置文件
├── README.md                        # 项目说明文件
└── package.json           

```

#### 安装教程

1. 克隆项目到本地 git clone https://gitee.com/hjmeng/MTools-Admin.git
2. 进入项目根目录 cd MTools-Admin
3. 安装包依赖 npm install
4. 本项目路由设计风格为动态添加路由(如果不满足你的需求，可以自行设计)

#### 使用说明

```shell

#------------- dll --------------#
# 开发环境生成dll
npm run dll:dev

# 测试环境生成dll
npm run dll:test

# 生产环境生成dll
npm run dll:prod

#------------- dev --------------#
# 启动开发环境
npm run dev

#------------- test --------------#
# 测试环境打包生成
npm run build:test

# 测试环境生成并本地调试
npm run build:test-preview

# 测试环境生成并开启性能检测
npm run build:test-report

#------------- prod --------------#
# 生产环境打包生成
npm run build:prod

# 生产环境生成并本地调试
npm run build:prod-preview

# 生产环境生成并开启性能检测
npm run build:prod-report

#------------- lint --------------#

# eslint检测
npm run lint:es

# eslint检测并修复
npm run lint:es-fix

# stylelint检测
npm run lint:style

# stylelint检测并修复
npm run lint:style-fix

# 同时eslint和stylelint检测并修复
npm run lint

#-------------------------------#
# prettier检测(代码格式化)
npm run format

```

#### 分支说明

1. master 默认分支
1. develop 调试分支
<!-- 以上两个分支主要用于项目分支开发 -->
<!-- 如果想要获取框架信息请查看框架分支 -->

#####  feature/* 项目分支

1. feature/init
    1. 项目初始化


#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request