添加 READMEDETAIL项目注解

This commit is contained in:
xiongchengqiang 2020-12-18 16:09:42 +08:00
parent dfebafabaf
commit a6f94340a0

30
READMEDETAIL.md Normal file
View File

@ -0,0 +1,30 @@
项目描述
1.该项目是一个kpi绩效管理系统以及绩效的一个过程管理使用vue2.0以及element-ui搭建。项目上线后使用钉钉pc端打开即可获取用户权限以及用户信息。
2.项目地址http://gitlab.ldxinyong.com/enterpriseManagement/digitization-ui
a)分支v_1.0.0 基本功能
b)分支v_1.1.0 在上个分支的基础上新增多人评分功能
c)分支v_porcess 在上个分支上新增kpi过程管理
项目细节
1. config文件夹主要是对webpack的配置以及代理配置
2. src文件夹包含了项目的主要结构
a)api文件是对接口地址统一分装
b)Assets主要存在静态文件图片
c)Compinents 主要是对项目重复组件进行分装存放
d)icons存放项目icon组件
e)minxinx存放全局变量主要是权限的控制本项目的权限使用前端控制后端不返回路由表
f)router存放项目的路由表
g)store存放项目的全局变量主要是个人的登录信息
h)style存放一些全局样式
i)utils存放公共js文件
j)views存放页面文件以及页面的专属组件不可复用组件
3.该项目kpi文件全部用于存放kpi系统的页面组件该项目的主路由为工作台-考核管理-绩效报表-设置
a)工作台工作台所有员工都有的页面其主要文件存放于src-views-kpi-workbench 下面其中assessmentGroup文件是考评组模块home是首页模块initiateAssessment发起考核模块todo是代办模块
b)考核管理主要存放在src-views-kpi-assessment下面其中goals是制定目标页面homeList考核管理的主页面performance绩效详情stepList考评组详情。
c)绩效报表主要存放在src-views-kpi-report下面home是主页面组件detail是点击详情跳转的界面
d)设置存放在src-views-kpi-set文件夹下
4.项目部分文件详解(下列文件都是存放于src下的文件)
a)mixins全局混入该项目只用了一次是用于权限按钮的控制其实现原理是一个data数据对象通过读取key进去控制。
b)router文件夹kpi_route.js是kpi系统的所有路由后面有其他项目接入只需要新建一份router的js文件并在index中引入即可加入路由。
c)style全局样式其中common.less 是全局公共样式文件public是重置样式文件index是引入文件
d)utils是公共类文件其中common.js封装一些对数据处理的方法elementConfig按需引入element组件permission控制获取用户信息主要是钉钉的免登接口调用
5.该项目引入了loadsh类主要用来处理数组对象的方法以及防抖节流等函数。