# HRP
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
基于 [vuejs 2.x][vuejs] 和 [element-ui][element-ui] 开发的的UI组件库。
## 目录结构
```bash
Project files/
├── .vscode/
├── docs/ ---- 工作区文档
├── public/ ---- 静态资源
│ └──index.html ----
├── scripts/
│ ├── server/ ---- 本地 mock 服务
│ │ ├── api/ ---- mock 接口
│ │ ├── index.js ---- webpack-dev-server 配置
│ │ ├── proxy.js ---- http 代理
│ │ └── router.js ---- 路由模块
├── src/ ---- 源码
│ ├── components/ ---- 公共组件
│ ├── models/ ---- 全局变量
│ ├── pages/
│ │ ├── index/ ---- 首页
│ │ ├── sysytem/ ---- 系统页
│ │ └── login/ ---- 登录页
├── tests/ ---- 单元测试
├── package.json
└── README.md
```
## 启动项目
你需要安装 [node.js][node.js] 的版本为 `nodejs >= 8.0`。
克隆此仓库后运行:
```shell
# 安装依赖,推荐使用 yarn 安装
$ npm install
# 启动开发模式
$ npm run serve
```
在 `package.json` 文件的 `scripts` 部分还有一些其他脚本可用.
## 编写 Mock 数据
> 文件需要写在 `scripts/server/api` 目录,编写完成会自动加载重启 vue 工程,无需手动处理
**简单示例**
```javascript
module.exports = {
// 获取当前登录用户信息
'GET /api/user/info': {
userId: 0,
nickname: '张三'
},
// 更新当前登录用户信息
'POST /api/user/update': 'ok',
// 获取 erp 员工列表
'GET /api/erp/staffs': {
'items|10': [
{
realname: '@cname()',
'sex|1': ['男', '女', '未知']
}
],
page: 1,
pageSize: 10,
total: '@integer(10,100)'
}
}
```
更多说明请阅读 [Mock 接口编写](./docs/mock.md) 文档.
## 版本发布
```bash
# 构建生产代码
$ npm run build
# 构建测试环境代码
$ npm run build -- --mode test
```
## 升级日志
[ChangeLog](./docs/CHANGELOG.md).
[element-ui]: https://element.eleme.cn/
[node.js]: https://nodejs.org/
[vuejs]: https://cn.vuejs.org/