Make starter project delivery-ready

This commit is contained in:
zhougf committed 2026-05-31 00:55:04 +08:00
1 parent 5b300dee0d
commit d7bfde754b
22 files changed
+695 -71

No files matched your search

+9
View File
@@ -166,6 +166,11 @@ const sources = defineDataSources({
字段说明:
- `url`: 请求地址。
- `baseUrl`: API 基础地址,建议来自 `.env`。
- `query`: 查询参数。
- `headers`: 静态 header 或返回 header 的函数。
- `authToken`: token 字符串或返回 token 的函数,会自动写入 `Authorization: Bearer <token>`。
- `timeoutMs`: 超时时间。
- `init`: `fetch` 的 RequestInit 参数。
- `intervalMs`: 轮询间隔,不传则只请求一次。
- `immediate`: 是否立即请求,默认 `true`。
@@ -186,6 +191,8 @@ const sources = defineDataSources({
url: 'ws://localhost:3000/ws/alerts',
mode: 'append',
maxItems: 20,
reconnect: { enabled: true, maxRetries: 10, delayMs: 3000 },
heartbeat: { message: 'ping', intervalMs: 30000 },
transform: (raw) => ({
time: raw.time,
message: raw.message
@@ -200,6 +207,8 @@ const sources = defineDataSources({
- `protocols`: 可选 WebSocket protocols。
- `mode`: `replace` 或 `append`,默认 `replace`。
- `maxItems`: `append` 模式最多保留多少条。
- `reconnect`: 断线重连设置。
- `heartbeat`: 心跳消息设置。
- `transform`: 单条消息的清洗函数。
WebSocket 消息如果是字符串,会优先尝试 `JSON.parse`。如果不是 JSON,会把原始字符串传给 `transform`。
+104
View File
@@ -0,0 +1,104 @@
# 部署与上线检查清单
本文档用于客户大屏项目交付前的最后检查。
## 1. 本地构建
```bash
pnpm install
pnpm typecheck
pnpm build
```
单个客户项目构建:
```bash
pnpm --filter @dev-screen-starter/customer-a build
```
## 2. 环境变量
新项目会带 `.env.example`:
```txt
VITE_API_BASE_URL=http://localhost:3000
VITE_WS_URL=ws://localhost:3000/ws/screen
VITE_ENABLE_STAGE_DEBUG=true
```
交付环境建议:
- 开发环境可以打开 `VITE_ENABLE_STAGE_DEBUG=true`。
- 生产环境建议关闭调试浮层。
- API 和 WebSocket 地址不要写死在组件里,统一放到 `dataSources.ts` 或 `.env`。
## 3. Nginx 静态部署
构建完成后,把对应项目的 `dist` 发布到静态服务器。
示例 Nginx 配置在:
```txt
deploy/nginx.conf
```
## 4. Docker 部署
默认构建 demo:
```bash
docker build -t dev-screen-demo .
docker run --rm -p 8080:80 dev-screen-demo
```
构建指定客户项目:
```bash
docker build \
--build-arg APP_FILTER=@dev-screen-starter/customer-a \
--build-arg APP_PATH=apps/customer-a \
-t customer-a-screen .
```
## 5. 屏幕适配验收
至少检查这些尺寸:
- `1366x768`
- `1920x1080`
- `2560x1440`
- `3840x2160`
至少检查这些模式:
- `?scaleMode=fit`
- `?scaleMode=fill`
- `?scaleMode=stretch`
默认建议生产使用 `fit`。
## 6. 数据接入检查
- HTTP 数据源是否配置 `baseUrl`、`timeoutMs`、错误兜底。
- WebSocket 是否配置 `reconnect` 和 `heartbeat`。
- 实时列表是否设置 `maxItems`。
- 图表数据是否在 `transform` 中清洗成组件需要的结构。
- 断网、接口 500、空数据时页面是否仍可读。
## 7. 视觉检查
- 标题、指标、图例、坐标轴在 1080p 和 4K 下都清晰。
- 自动滚动列表没有超出父容器。
- 图表容器没有空白 canvas。
- 关键数字没有挤压、换行或遮挡。
- 客户看屏页面不出现开发调试信息。
## 8. 上线前清单
- `pnpm typecheck` 通过。
- `pnpm build` 通过。
- 客户接口地址已切换为正式地址。
- `.env` 未提交到 git。
- 生产关闭 `VITE_ENABLE_STAGE_DEBUG`。
- 浏览器全屏查看无滚动条、无遮挡。
- 大屏实际设备上验收一次。
+10 -1
View File
@@ -146,6 +146,8 @@ const metrics = data.metrics.data ?? []
其中 `mockSource`、`httpSource`、`websocketSource` 已可用;`mqttSource`、`signalrSource` 已预留类型和声明入口,具体 SDK 在客户项目需要时再接。
HTTP 数据源支持 `baseUrl`、`query`、`headers`、`authToken`、`timeoutMs`。WebSocket 数据源支持断线重连和心跳。
## 5. debug
`debug` 提供开发时调试组件。
@@ -189,7 +191,14 @@ const metrics = data.metrics.data ?? []
## 7. 项目模板
`templates/project-basic` 是新客户项目起点。
`templates/project-basic` 是新客户项目起点,默认包含:
- `ScreenStage` 适配和 debug。
- `dataSources.ts` 页面级数据源声明。
- `mockData.ts` 本地 mock 数据。
- `ChartPanel` 图表面板。
- `visual-kit` 状态区和告警区。
- `.env.example` 接口配置示例。
创建命令:
+5 -3
View File
@@ -129,12 +129,14 @@ doc/
- 图表工厂覆盖常用交付场景,并保留 ECharts 原生 option 覆盖能力。
- demo-screen 已包含状态区、运行事件、指标卡、趋势、堆叠、排行、玫瑰、双轴、雷达和仪表盘示例。
- `data` 包已新增统一数据源设计,支持页面集中声明 mock、HTTP、WebSocket 数据源,并预留 MQTT、SignalR 类型。
- `project-basic` 模板已升级,默认包含数据源声明、图表面板、visual-kit、`.env.example` 和屏幕适配 debug。
- 新增 `ChartPanel`,封装图表标题、loading、empty、error 和 ECharts 容器。
- 新增 Dockerfile、Nginx 配置和部署上线检查清单。
下一步建议:
- 做 `ChartPanel` 组合组件,把 `Panel + EChart + loading/empty/error` 固化下来。
- 给 `data` 包补 WebSocket 重连、心跳、鉴权 header/token 约定。
- 增加 `.env.example` 和项目级接口配置约定。
- 继续完善真实 MQTT、SignalR adapter。
- 按客户项目沉淀更多模板分支,例如运营大屏、设备大屏、销售驾驶舱。
- 对 `ScreenStage` 做更多截图验收,覆盖 1366x768、1920x1080、4K 和不同 `scaleMode`。
## 8. 成功标准