milesight/beaver-iot-web

Beaver IoT Web

Beaver IoT Web是一个基于Monorepo的前端项目，涵盖Web应用及其依赖的构建脚本、项目规范、国际化和公共代码库。它通过Pnpm Workspace管理，提供统一的开发环境与构建流程，降低开发维护成本。

目录结构

beaver-iot-web
├── apps            # 应用目录
│   └── web         # Web应用
│
├── packages        # 依赖库目录
│   ├── locales     # 国际化库
│   ├── scripts     # 公共脚本库
│   ├── shared      # 公共代码库
│   └── spec        # 项目规范库
│
├── README.md
├── package.json
├── pnpm-lock.yaml
└── pnpm-workspace.yaml

开发与维护

基础环境配置

推荐使用Pnpm管理项目环境与依赖，要求pnpm>=8.0.0、node>=20.0.0（低于该版本不支持）。

1. 安装Pnpm

bash
curl -fsSL https://get.pnpm.io/install.sh | sh -

参考https://pnpm.io/installation%E3%80%82

2. 安装Node

bash
# 安装Node.js LTS版本
pnpm env use --global lts

参考https://pnpm.io/cli/env%E3%80%82

3. 本地克隆仓库 生成SSH Key（若本地无）：

bash
# 按提示按Enter完成
ssh-keygen -t rsa -C "your_email@domain.com"

# 复制公钥（Windows Git Bash）
cat ~/.ssh/id_rsa.pub | clip

# 复制公钥（Mac）
cat ~/.ssh/id_rsa.pub | pbcopy

将公钥添加到GitLab的用户设置->SSH Keys，然后克隆项目：

bash
git clone git@github.com:Milesight-IoT/beaver-iot-web.git
cd beaver-iot-web
# 配置提交用户名和邮箱（全局添加--global参数）
git config user.name xxx
git config user.email xxx@domain.com

启动本地开发服务

bash
# 安装依赖
pnpm i

# 启动本地开发服务（@milesight包依赖也会启动）
pnpm run start

国际化开发

项目支持国际化，文本内容维护在packages/locales库。新增文本建议添加到packages/locales/src/lang/en对应模块，开发完成后执行pnpm run i18n:export导出待翻译JSON；翻译文本放入packages/locales/import目录，执行pnpm run i18n:import导入到应用可用。

构建编译

bash
pnpm run build

该命令会构建Monorepo中所有子应用与依赖库，输出位于各子库的dist目录。

常用命令

Docker部署示例

Docker Run

bash
docker run -d -p 8080:80 --name beaver-iot-web milesight/beaver-iot-web

访问http://localhost:8080即可使用应用。

Docker Compose

创建docker-compose.yml：

yaml
version: '3'
services:
  beaver-iot-web:
    image: milesight/beaver-iot-web
    ports:
      - "8080:80"
    restart: always

执行docker-compose up -d启动服务。

相关链接

• https://pnpm.io/
• https://nodejs.org/