102 lines
2.4 KiB
Markdown
102 lines
2.4 KiB
Markdown
# Dev Screen Starter
|
|
|
|
Dev Screen Starter 是一个面向项目交付的大屏开发基础框架。它不提供拖拽式设计器,而是为每个客户项目提供可复用的屏幕适配、图表容器、数据刷新、调试工具和部署骨架。
|
|
|
|
## 定位
|
|
|
|
适合这种工作流:
|
|
|
|
1. 接到客户大屏项目。
|
|
2. 根据需求新建一个项目页面。
|
|
3. 图表、布局、业务逻辑按客户定制开发。
|
|
4. 复用基础框架能力,减少重复搭建成本。
|
|
|
|
不适合:
|
|
|
|
- 让非技术人员拖拽搭屏。
|
|
- 做通用低代码平台。
|
|
- 维护复杂组件配置市场。
|
|
|
|
## 技术栈
|
|
|
|
- React
|
|
- TypeScript
|
|
- Vite
|
|
- ECharts
|
|
- pnpm workspace
|
|
|
|
## 目录
|
|
|
|
```txt
|
|
apps/demo-screen/ 示例客户大屏
|
|
packages/screen-core/ 屏幕适配、舞台、布局基础能力
|
|
packages/charts/ ECharts 容器、状态封装、主题工具
|
|
packages/data/ HTTP、轮询、mock、数据转换
|
|
packages/debug/ 开发调试面板和日志工具
|
|
packages/visual-kit/ 大屏视觉装饰和展示组件
|
|
templates/project-basic/ 新客户项目模板
|
|
doc/ 项目规划和实施文档
|
|
```
|
|
|
|
## 复用能力
|
|
|
|
### 屏幕适配
|
|
|
|
`@dev-screen-starter/screen-core` 提供 `ScreenStage`,默认以 `1920x1080` 为设计尺寸,通过 `fit` 缩放适配不同分辨率。业务页面只需要按设计稿绝对定位或栅格布局。
|
|
|
|
### 图表工厂
|
|
|
|
`@dev-screen-starter/charts` 提供 ECharts 容器和常用 option 工厂:
|
|
|
|
- `createLineOption`
|
|
- `createAreaTrendOption`
|
|
- `createBarOption`
|
|
- `createStackedBarOption`
|
|
- `createDualAxisOption`
|
|
- `createRankBarOption`
|
|
- `createPieOption`
|
|
- `createRosePieOption`
|
|
- `createGaugeOption`
|
|
- `createRadarOption`
|
|
- `mergeChartOption`
|
|
|
|
业务项目优先使用工厂函数,遇到客户定制需求时用 `mergeChartOption` 覆盖局部 option。
|
|
|
|
### visual-kit
|
|
|
|
`@dev-screen-starter/visual-kit` 提供常用大屏展示和装饰组件:
|
|
|
|
- `GlowPanel`
|
|
- `CornerFrame`
|
|
- `TitleBar`
|
|
- `SectionTitle`
|
|
- `Divider`
|
|
- `DigitalNumber`
|
|
- `FlipNumber`
|
|
- `StatusPill`
|
|
- `TrendBadge`
|
|
- `ScrollTable`
|
|
- `MarqueeList`
|
|
- `WaterLevel`
|
|
|
|
使用时需要在项目入口引入样式:
|
|
|
|
```ts
|
|
import '@dev-screen-starter/visual-kit/styles.css'
|
|
```
|
|
|
|
## 命令
|
|
|
|
```bash
|
|
pnpm install
|
|
pnpm dev
|
|
pnpm typecheck
|
|
pnpm build
|
|
```
|
|
|
|
## 项目文档
|
|
|
|
- [项目规划](doc/project-plan.md)
|
|
- [项目框架说明](doc/framework.md)
|
|
- [交付流程](doc/delivery-workflow.md)
|