gcht

陀螺匠·企业助手

开发规范

统一使用 ES6 语法 方法注释 /*

• th => 表头
• data => 数据
• fileName => 文件名
• fileType => 文件类型
• sheetName => sheet 页名 */ export default function toExcel ({ th, data, fileName, fileType, sheetName }) 行注释 //

命名

页面目录 文件夹命名格式骆驼式命名法,例如：用户列表 userList 例如：个人中心 user 个人中心 ├─ company 我的企业 ├─ examine 申请审批 ├- forum 知识社区

页面命名、组建、文件夹 命名格式小驼峰命名法,例如：用户列表 userList

类名函数命名 大驼峰式 例如：addUser 变量命名 小驼峰式 例如：user 或者 userInfo 常量 采用全大些下划线命名 例如：VUE_APP_API_URl

文件管理规范

src 页面模块必须件文件夹区分 api 接口一个模块一个文件 assets 静态文件目录 components 全局组件目录 directive 自定义v-的js文件 lang 多语言 layout 初始化组件 libs 自定义常用函数 mixins 发送短信验证码 router 全局路由设置 一个模块在 modules 中建一个文件夹 store 路由状态管理，一个模块在 modules 中建一个文件夹 styles 样式尽量采用 element-ui 自带组件，common.less 系统通用样式不要轻易动 utils 自定义工具 js 独立命名，一般不用新建文件夹 views 前端代码静态文件目录

模块命名

├─ administration 行政管理
├─ business 办公审批
├─ product 商品管理
├─ customer 客户管理
├─ error-page 全局错误页
├─ user 用户管理
├─ fd 财务管理
├─ hr 人事管理
├─ logo 登录与注册页面
├─ setting 系统身份管理 系统权限管理、系统菜单管理、操作日志
├─ user 个人中心 工作台、我的日程、办公中心、企业动态、企业通讯录、职位说明、知识社区等等

目录结构

主要目录结构及说明：

├── public                    # 静态资源
│   ├── iconfont              # iconfont 图标
│   └── UEditor               # 编辑器图标
│   └── favicon.ico           # 浏览器窗口小图标 
├── src                       # 源代码
│   ├── api                   # 所有接口api
│   │    └──administration.js # 请求封装
│   │    └──business.js       # 有办公审批的接口
│   │    └──config.js         # 有关初始化的接口
│   │    └──enterprise.js     # 有企业相关的接口
│   │    └──request.js        # 有关api初始化的接口
│   │    └──setting.js        # 有关权限管理的接口
│   │    └──system.js         # 有关系统配置的接口
│   │    └──systemForm.js     # 有关表单组件的接口
│   │    └──user.js           # 有关登录、用户的接口
│   ├── assets                # 图片、svg 等静态资源
│   ├── icons                 # svg 等静态资源
│   ├── components            # 公共组件
│   │    └──accessCommon      # 公共考核标签设置
│   │    └──approvalBill      # 添加明细组件
│   │    └──approvalBillView  # 查看明细组件
│   │    └──Breadcrumb        # 头部标题标签
│   │    └──CLTable           # 无计算高度的table组件
│   │    └──dateQuarter       # 选择季度与半年考核组件
│   │    └──defaultPage       # 缺省页
│   │    └──department        # 考核模板库与指标库导航
│   │    └──departmentTree    # 选择人员/部门
│   │    └──departmentTreeChange   # 审批流程中选择人员/部门
│   │    └──dialogForm        # Form表单dialog弹框
│   │    └──echarts           # echarts封装
│   │    └──ELTable           # 计算高度的table组件
│   │    └──exportExcel       # excel批量导出
│   │    └──importExcel       # excel批量导入
│   │    └──LangSelect        # 多语言切换
│   │    └──payment           # 全局支付接口
│   │    └──selectTarget      # 选择指标库
│   │    └──selectTemplate    # 选择模板库
│   │    └──uploadFrom        # 上传附件
│   │    └──uploadPicture     # 上传图片
│   ├── layout                # 导航布局
│   │    ├──index             # 主页面
│   │    ├──components        # 导航组件
│   │        └──headerNotice  # 顶部消息中心
│   │        └──Document      # 右下角陀螺匠帮助中心
│   │        └──TagsView      # tab标签页导航
│   │        └──Navbar        # 头部导航
│   │        └──AppMain       # 导航路由
│   │        └──index.js      # 组件引用
│   │    └──mixins            # 自适应大小
│   ├── libs                  # 公共js方法
│   │    └──settingMer        # 配置请求地址
│   ├── views                 # 所有页面
│   │    └──login                    # 登录
│   │         └──index               # 登录
│   │    └──dashboard                # 首页
│   │    └──user                     # 个人办公
│   │         └──workbench           # 工作台
│   │         └──workCalendar        # 我的日程
│   │         └──examine             # 申请审批
│   │         └──workDaily           # 我的汇报
│   │         └──workAssessment      # 绩效考核
│   │         └──workCloudfile       # 云文件
│   │         └──workNotice          # 企业动态
│   │         └──workEnt             # 企业通讯录
│   │         └──workDuty            # 职位说明
│   │         └──forum               # 知识社区
│   │         └──memorandum          # 记事本
│   │         └──news                # 消息中心
│   │         └──company             # 我的企业
│   │    └──customer                 # 客户管理
│   │         └──list                # 客户列表
│   │         └──invoice             # 发票管理
│   │         └──contract            # 合同管理
│   │         └──setupWork           # 业务设置
│   │         └──setupLabel          # 客户标签
│   │         └──setupType           # 客户分类
│   │    └──hr                       # 人事管理
│   │         └──archivesUser        # 员工档案
│   │         └──assessStaff         # 员工绩效
│   │         └──assessConfig        # 考核设置
│   │         └──enterprise          # 人事管理
│   │              └──group              # 组织架构
│   │              └──articleCategory    # 文章分类
│   │              └──job                # 职位管理
│   │    └──business                 # 审批
│   │         └──examine             # 办公审批
│   │         └──record              # 审批记录
│   │    └──fd                       # 财务管理
              └──examine             # 财务审核
│   │         └──invoice             # 发票管理
│   │         └──enterprise        
│   │              └──billList       # 收支记账
│   │              └──billChart      # 收支统计
│   │              └──billCate       # 账目分类
│   │              └──billType       # 支付方式      
│   │    └──administration           # 行政管理
│   │         └──notice              # 企业动态
│   │         └──material 
│   │           └──chart             # 物资概览
│   │           └──list              # 物资记录
│   │           └──staff             # 物资管理
│   │    └──setting                  # 系统管理
│   │         └──enterprise          
│   │           └──info             # 企业信息
│   │           └──group            # 用户权限
│   │           └──admin            # 角色权限
│   │           └──group            # 用户权限
│   │         └──system         
│   │           └──menu             # 菜单管理
│   │           └──log              # 操作日志
│   │         └──enterprise      
│   │           └──workbench        # 工作台设置  
│   │           └──news             # 消息设置  
│   │           └──attach           # 素材管理 
│   │         └──data             
│   │           └──legal            # 权益数据
│   │           └──order            # 历史订单
│   │           └──invoice          # 发票申请
│   │  
│   ├── filters                      # 过滤器
│   ├── router                           # 路由配置
│   │    └──modules                      # 页面路由模块
│   │         └──user.js                  # 有关个人办公
│   │         └──business.js                  # 有关审批
│   │         └──setting .js                  # 有关系统管理
│   │         └──administration .js           # 有关行政管理
│   │         └──fd.js                        # 有关财务管理
│   │         └──hr.js                        # 有关人事管理
│   │         └──customer.js                  # 有关客户管理   
│   │    └──index.js                          # 路由的汇总
│   ├── store                                 # Vuex 状态管理
│   ├── utils                                 # 全局公用方法
│   ├── styles            # 样式管理
│   ├── permission.js     # 路由拦截
│   ├── setting.js        # 业务配置文件
│   ├── main.js           # 入口文件 加载组件 初始化等
│   └── App.vue           # 入口页面
├── tests                      # 测试
├── .env.xxx                   # 环境变量配置
├── .eslintrc.js               # eslint 配置项
├── .babelrc                   # babel-loader 配置
├── .travis.yml                # 自动化CI配置
├── vue.config.js              # vue-cli 配置
├── postcss.config.js          # postcss 配置
└── package.json               # package.json

开发打包项目

# 进入项目目录
$ cd admin-oa-ent

# 安装依赖
$ npm install

# 启动项目(本地开发环境)
$ npm run dev

# 打包项目
## Build

```bash
# build for test environment
npm run build:stage

# build for production environment
npm run build:prod
```
## Advanced
```bash
# preview the release environment effect
npm run preview

# preview the release environment effect + static resource analysis
npm run preview -- --report

# code format check
npm run lint

# code format check and auto fix
npm run lint -- --fix
```