前端交接文档_前端开发怎么写工作交接

Web前端开发工作交接文档

一、项目总览

项目名称：急诊临床信息系统

运用技术：开发中运用的技术包括ReactJs，seamless-immutable，Scss以及第三方库AntD，Ag-grid等的使用。注：项目中大部分是项目开发人员封装的组件，组件内部有注释或文档

项目版本：急诊前后台项目都以hieip-client作为项目名称前缀，hieip-client-ts为急救中心版本，hieip-client-cjq为陈家桥版本，两个版本目录结构基本一致。

目录结构：

1. 根目录文件

   根目录	含义
   config.js.default	默认配置文件，打包后的配置文件
   config.js	项目启动配置文件，初次clone项目时需要手动建立
   point.yml	权限点配置文件，修改后需运行gulp下的generatePoint
   .gitmodules	更新后台api的地址文件，修改其中的url地址即可

2. src目录

   src	含义
   package	后端API及前端封装的组件
   service	中间层，逻辑处理都放在此目录
   style	公共样式目录
   test	测试文件目录
   tools	公共工具类目录
   view	视图层，所有页面存放在此目录

3. 其余或未提及目录或文件，是框架文件，不能轻易修改

二、项目进度

目前项目基本是竣工状态，只遗留了部分问题，后续可能会根据不同医院提出的不同需求进行代码改动。因为是初期版本，所有代码有部分地方冗余程度比较高，建议重构这部分代码。之前有md5值校验的，后续把这个校验关闭了，故在合并他人代码时，需要查看他具体书写了什么东西，是否修改到重要文件，如果发现有会影响到主分支的代码，切勿合并，以免引起代码冲突，主分支无法使用。代码检验是使用的sonarQube，所以在进行写代码之前多看看相关文档，提高代码质量，加快运行速度。

未完成工作：预检分诊检伤功能(照相及视频功能)，患者概览检伤记录，门诊床位情况对接，患者概览出入量维护，观察项维护

需完善工作：指控统计指标，病历详情，集成试图

三、项目启动

项目工具

• GIT

Git是目前世界上最先进的分布式版本控制系统，项目采用Git作为版本控制器。

下载地址：Git for Windows

Git推荐学习文档：Git docs

Git安装手册

• Yarn

项目采用Yarn来代替NPM，相对于NPM，Yarn速度更快，版本控制更精确，并且支持离线模式。Yarn的命令和NPM大相径庭，熟悉NPM的可以快速上手Yarn。

安装Git时，需按照以下步骤进行安装，否则会出现代码提交失败或项目启动失败的情况

下载地址：Yarn for Windows

Yarn官方手册：Yarn docs

• Node.js

下载地址：Node.js

Node官方文档：node docs

• python

项目采用python版本为2.x，下载版本的时候需注意版本号。

下载地址：python

python官方文档：python docs

• ssh密钥

ssh密钥安装和更改

• Electron

Electron是由Github开发，用HTML，CSS和JavaScript来构建跨平台桌面应用程序的一个开源库。

项目编译及启动

1. 安装完上述工具之后，向管理员取得对应项目的相应权限，通过git clone的方式将项目下载下来，使用webStrom将项目导入

2. 在项目根目录下，找到config.json.default文件，将其复制，并在根目录粘贴。此时会弹出重命名窗口，将default删除，文件重命名为config.json即可。

3. 操作完步骤2后，在webstrom命令行输入yarn install安装依赖包。(注意安装完依赖包后不要马上去执行步骤4，此时webStrom正在把安装好的依赖包进行索引)

4. 在命令行执行yarn run find:module&dll，预加载和编译包。

5. 在命令行输入yarn run webpack:dev，此命令之后不会自动结束，这是启动项目的前置条件，不要关闭它，否则项目会无法启动。

6. 最后在命令行输入yarn run start启动项目。首次启动需科学上网