Files
dev-screen-starter/doc/project-plan.md
T

145 lines
4.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Dev Screen Starter 项目计划
## 1. 项目目标
Dev Screen Starter 不做拖拽式大屏设计器,而是提供一套项目型大屏开发基础框架。每次接到客户项目时,开发人员基于模板新建项目页面,根据客户需求定制布局、图表、数据接口和视觉风格。
核心目标:
- 5 分钟创建一个新客户大屏项目。
- 复用屏幕适配、图表容器、数据刷新、调试工具和部署骨架。
- 保持每个项目的代码自由度,避免被低代码配置体系限制。
- 让客户只看到高质量运行页,不接触编辑器。
## 2. 不做什么
- 不做拖拽编辑器。
- 不做组件市场。
- 不做配置化属性面板。
- 不做客户自助搭屏。
- 不做通用低代码平台。
## 3. 技术路线
基础技术栈:
- React
- TypeScript
- Vite
- ECharts
- pnpm workspace
推荐部署方式:
- 静态构建产物部署到 Nginx、对象存储或客户服务器。
- 数据接口由客户系统、轻量代理服务或项目后端提供。
- 高频实时数据按项目需要接 WebSocket、SSE 或 MQTT。
## 4. 项目结构
```txt
apps/
demo-screen/ 示例大屏项目
packages/
screen-core/ 屏幕适配、舞台、基础面板、指标卡
charts/ ECharts 容器和通用图表默认配置
data/ 请求、轮询、mock、数据转换
debug/ 开发调试浮层
visual-kit/ 视觉装饰和展示组件
templates/
project-basic/ 新客户项目模板
scripts/
create-project.mjs 新建项目脚本
doc/
project-plan.md
framework.md
delivery-workflow.md
```
## 5. 第一阶段
目标:建立可复用基础框架和示例大屏。
交付内容:
- `ScreenStage`:负责设计稿尺寸和屏幕适配。
- `Panel`:常规大屏面板容器。
- `MetricCard`:常见指标卡。
- `EChart`:ECharts 自动初始化、销毁和 resize。
- `usePollingData`:基础轮询数据 hook。
- `DebugBadge`:开发环境调试浮层。
- `visual-kit`:发光面板、四角框、标题、数字强调、状态标签、滚动表格、水位图。
- `demo-screen`:示例大屏项目。
- `project-basic`:新客户项目模板。
- `pnpm new <name> [title]`:新建项目命令。
## 6. 第二阶段
目标:提升项目交付效率。
已完成内容:
- 增加常用图表 option 工厂:
- 折线图
- 面积趋势图
- 柱状图
- 堆叠柱状图
- 双轴折线柱状图
- 饼图
- 玫瑰图
- 排名列表
- 仪表盘
- 雷达图
- 增加 `mergeChartOption`,支持项目按客户需求覆盖局部 ECharts option。
- 扩展 `visual-kit`:
- `TitleBar`
- `Divider`
- `FlipNumber`
- `TrendBadge`
- `MarqueeList`
- demo-screen 已改为使用图表工厂和 visual-kit 组合出项目型模板。
后续计划:
- 增加 `ChartPanel` 组合组件。
- 增加 mock/real 数据切换约定。
- 增加 `.env` 示例。
- 增加 Dockerfile 和 Nginx 静态部署模板。
## 7. 第三阶段
目标:沉淀项目经验和可复制交付流程。
计划内容:
- 建立客户项目目录规范。
- 建立视觉主题模板。
- 建立数据接口适配规范。
- 建立截图验收清单。
- 建立大屏上线检查清单。
## 9. 当前进度
最近完成:
- `visual-kit` 已独立导出样式,业务项目可直接引入。
- 基础装饰组件支持 `className`、`style`、`tone`、`size` 等通用属性。
- 图表工厂覆盖常用交付场景,并保留 ECharts 原生 option 覆盖能力。
- demo-screen 已包含状态区、运行事件、指标卡、趋势、堆叠、排行、玫瑰、双轴、雷达和仪表盘示例。
下一步建议:
- 做 `ChartPanel` 组合组件,把 `Panel + EChart + loading/empty/error` 固化下来。
- 给 `data` 包增加 mock/real 数据源切换。
- 增加 `.env.example` 和项目级接口配置约定。
- 对 `ScreenStage` 做 1366x768、1920x1080、4K 的浏览器截图验收。
## 8. 成功标准
- 新项目能通过模板快速创建。
- 示例大屏可运行、可构建。
- 1920x1080 设计稿能适配不同屏幕。
- 图表容器能自动 resize。
- 项目开发时能清楚看到调试信息。
- 每个客户项目可以自由写代码,不受设计器配置限制。