jczh-api-library v1.0.21

监测指挥公用 API 库

负责人：赵仲（打包，发布等）

1. 使用原则

• 后端标准化服务 API，均可放入此项目。
• 此库可直接在项目中引用，开发人员不必再通过前端 mapper 工具重复导入公用接口。
• 此库亦为「前端组件商店」提供 API 层面的封装。
• 鼓励所有人对此组件库做出贡献

2. 文件夹介绍

• build：build脚本文件，tsc 直接编译
• packages：主要源码
  • apis：公用接口封装
  • types：接口 typescript 类型定义
• docs：vitePress 文档文件夹
• website：文档网站

3. 安装过程

1. 全局安装pnpm：npm install -g pnpm
2. 执行pnpm i --force

• 安装时遇到大量包请求报错，请先查看 .npmrc 文件中是否配置了「代理」，如果是，则先将代理配置为本机代理 或 注释掉代理配置，再执行安装；
• 安装过程慢的话，可以自己设置不同的npm registry或者修改.npmrc文件中的代理地址；
• 如安装后报错「sh: vite: command not found」，则可能是依赖未装全，建议切换到 npm 官方源，配置翻墙代理后，再进行安装；

4. 使用说明

新建文档（Doc）步骤 - 待修改完善

1. 在docs/目录下新建*.md文件
2. 在website/nav.config.json里添加对应的路由

调试过程

1. 编写好对应的文档后，执行pnpm pnpm docs:dev 命令
2. 打开对应的文档地址，查看效果

打包发布过程

1. 升级版本：package.json 中的版本号
2. 执行 pnpm build 命令
3. 设置相应的 NPM Registry 地址（默认地址为公司的私有仓库）
4. 执行 pnpm pub 命令

构建帮助文档过程

1. 执行 pnpm docs:build 命令
2. 执行 pnpm docs:publish 命令，将文件上传到服务器