Browse Source

更新说明文档

master
qinjian 1 month ago
parent
commit
541597de5e
  1. 34
      README.md

34
README.md

@ -1,25 +1,14 @@
# 无源标靶上位机
## 开发注意事项
- 请确保在开发环境中,`server/tcpProxy/index.js` 文件中的 `TCP_HOST` 设置为下位机的实际 IP 地址
- 提交代码前,请将 `TCP_HOST` 设置回去
- 确保在生产环境中,[摄像头流地址](./client/src/sections/wuyuanbiaoba/components/CameraView.jsx),摄像头流的 streamUrl 指向正确的地址
- 提交代码前,请将 `streamUrl` 设置回去
## 本地开发
### 启动开发服务器
```bash
# 普通开发模式
npm start
# 本地开发模式(使用 localdev 环境标识)
npm run start:dev
# 自定义端口启动(默认端口为 5000)
npm start -- --port 3000
```
### 环境配置
@ -36,7 +25,15 @@ npm start -- --port 3000
### 部署步骤
**打包**
```shell
npm run pack
```
**特别注意**
版本更新记得更改 package.json 文件中的版本号
确保下位机已经安装了 nodejs 环境,并且版本在 20 以上(推荐v20.19.3),注意,nodejs 环境必须是 root 用户可用的,服务自启动需要 systemd 的操作权限。
1. 从项目的 [release](https://gitea.anxinyun.cn/qinjian/wuyuanbiaoba_web/releases) 页面下载最新的打包文件,如 `wuyuanbiaoba-web-x.x.x.tar.gz`
@ -49,22 +46,27 @@ npm start -- --port 3000
8. 查看日志 `journalctl -u wuyuanbiaoba-web.service -f`
### 离线版本说明
离线部署包构建指令
```shell
npm run build:offline
```
该指令执行后会连接到某个远程的linux环境,进行部署包的构建:详情请查看 `script/package-app-offline.sh` 文件
针对设备无法联网的情况,提供离线安装包,离线安装包包含了所有的依赖包,无需联网即可完成安装。
**在线版本与离线版本的区别:** 针对设备无法联网的情况,提供离线安装包,离线安装包包含了所有的依赖包,无需联网即可完成安装。
**!!!!注意,依然需要nodejs环境**
离线安装包的部署步骤与在线版本相同,只需下载离线安装包 `wuyuanbiaoba-web-x.x.x-offline.tar.gz` 即可。
## 构建打包
```bash
# 构建生产版本
npm run build
# 打包在线版本
# 打包在线部署版本
npm run pack
# 打包离线版本
# 打包离线部署版本
npm run pack:offline
```

Loading…
Cancel
Save