# 说明文档

# xigital

> 这是一个基于 `vue-cli` 进行构建的项目。它包含了 Element UI & axios & iconfont & permission control & lint，这些搭建项目必要的东西。

## 目录结构
------------------------

```bash
├── /build/           # 项目构建(webpack)相关配置
├── /dist/            # 编译生成文件目录
├── /mock/            # mock本地服务
├── /public/          # 项目的入口文件目录
├── /src/             # 源码目录
│ ├── /api/           # 请求
│ ├── /assets/        # 组件静态资源(图片)
│ ├── /components/    # 公共组件
│ ├── /icons/         # svg图标
│ ├── /layout/        # layout
│ ├── /router/        # 路由配置
│ ├── /store/         # vuex状态管理
│ ├── /styles/        # css样式
│ ├── /utils/         # 公共方法
│ ├── /vendor/        # 插件
│ ├── /views/         # 路由组件(页面维度)
│ ├── App.vue         # 组件入口
│ ├── main.js         # 程序入口
│ ├── permission.js   # 权限控制
│ └── settings.js     # 配置文件
├── .editorconfig     # 定义代码格式
├── .env.development  # 开发环境配置
├── .env.production   # 正式环境配置
├── .env.staging      # 测试环境配置
├── .eslintgnore      # 忽略语法规范文件配置
├── .eslintrc.js      # ES6语法规范配置
├── .gitignore        # git忽略文件
├── .prrettierrc      # 编辑器配置
├── .travis.yml       # travis配置
├── .babel.config.js  # babel配置
├── .jest.config.js   # jest单元测试配置
├── .jsconfig.json    # jsconfig配置
├── LICENCE           # LICENCE
├── package.json      # 项目依赖
├── package-lock.json # 项目依赖
├── .postcssrc.config.js # css前缀
├── README-zh.md      # 项目中文文档
├── VScodeSettings.txt   # VScode配置
└── vue.config.js     # 可选的配置文件
```


## 构建（Build Setup）

```bash
# 进入项目目录
cd xigital

# 安装依赖
npm install

# 建议不要直接使用 cnpm 安装依赖（会有各种诡异的 bug）。可以通过如下设置淘宝镜像的方式解决 npm 下载速度慢的问题
npm install --registry=https://registry.npm.taobao.org

# 启动服务
npm run dev
```

浏览器访问 [http://localhost:8080](http://localhost:8080)

## 发布

```bash
# 构建测试环境
npm run build:stage

# 构建生产环境
npm run build:prod
```

## 其它

```bash
# 预览发布环境效果
npm run preview

# 预览发布环境效果 + 静态资源分析
npm run preview -- --report

# 代码格式检查
npm run lint

# 代码格式检查 + 自动修复
npm run lint -- --fix

# jest单元测试
npm run test:unit

# 代码格式检查 + jest单元测试
npm run test:ci

# SVG在线压缩合并
npm run svgo
```

## 兼容浏览器（Browsers support）

Modern browsers and Internet Explorer 10+.

| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari |
| --------- | --------- | --------- | --------- |
| IE10, IE11, Edge| last 2 versions| last 2 versions| last 2 versions