第 0 步:准备环境
你只需要 Node.js(版本要求 ^20.19.0 或 >=22.12.0)和 npm。检查版本:
node -v
第 1 步:安装与启动(1 分钟)
# 克隆/获取代码后,进入 ricon-viz 目录
npm install
# 启动开发服务
npm run dev
服务运行在 http://localhost:5180(端口可在 vite.config.ts 的 server.port 修改),启动后自动打开浏览器。
不需要数据库、不需要后端服务——所有接口走本地 Mock,数据以 localStorage 持久化,开箱即用。
第 2 步:认识三个页面(1 分钟)
ricon-viz 有三块业务:
- 大屏管理:大屏列表,支持新建、复制、导入导出;
- 可视化设计器:三栏布局——左边图元库,中间画布,右边属性面板;
- 大屏预览:
/viewer只读渲染页。
第 3 步:搭一块大屏(2 分钟)
- 新建大屏:在大屏管理页新建一块,进入设计器;
- 拖入图元:从左侧图元库拖一个「柱状图」到画布,再拖一个「数字翻牌」;
- 调整布局:拖动改位置、拉手柄改尺寸,拖动时留意参考线的吸附提示;
- 改个标题:选中柱状图,右侧属性面板改标题文字;
- 配动画:给数字翻牌配一个入场动画,预览时它会「翻」出来。
第 4 步:绑数据(1 分钟)
选中柱状图,切换到「数据」标签:
- 选静态数据,直接填入一组名称/数值,图表立刻变化;
- 以后接真实接口时,切换为动态请求并配置字段映射即可。
第 5 步:预览与发布
点「预览」进入 /viewer:
- 检查四种适配方式的效果(等比缩放最常用);
- 配置了轮询的图元会自动刷新;
- 浏览器全屏(F11),第一块大屏正式「上岗」。
回到大屏管理页,还可以复制大屏做模板、导出文件分享给同事。
常见问题速查
完整 FAQ 见 docs/guide/faq.md,这里列三个高频项:
| 问题 | 处理 |
|---|---|
| 启动报 Node 版本不符 | 升级到 20.19+ 或 22.12+ |
npm run build 类型报错 | 先 npm run type-check 定位;急出包可 npx vite build 跳过类型检查 |
| 本地预览打包产物 | npm run preview |
下一步去哪
- 系统学:
docs/guide/下的开始、快速上手、设置介绍三篇; - 想扩展:
docs/develop/的「新增 ECharts 图元」「新增基础图元」教程,10 分钟给自己的业务图表做个图元; - 看架构:
docs/design/的目录结构、工作空间、图元数据结构; - 在线看:官网 http://www.ricon.cloud ,产品介绍与文档中心,浏览器里直接读。
祝你的第一块大屏顺利点亮。
4863



被折叠的 条评论
为什么被折叠?



