数字标牌软件使用教程
1. 项目介绍
本项目是一款简单易用的自托管数字标牌软件,可以将普通屏幕转变为美观的内容显示系统。它具有模块化的设计,允许用户自由添加和调整各种小工具,以展示各种类型的内容,如幻灯片、天气信息、恭喜信息、YouTube 视频嵌入、网页(iframe)、独立图像、公告和列表等。
2. 项目快速启动
环境准备
- 安装 MongoDB 数据库,可以在本地或云环境中创建一个名为
digitaldisplay
的数据库。 - 确保你的系统中已经安装了 Node.js。
克隆项目
git clone https://github.com/wassgha/digital-signage.git
cd digital-signage
设置数据库连接
编辑 .env.example
文件,将示例内容复制到新的 .env
文件中,并替换为你的 MongoDB 数据库 URI。
cp .env.example .env
编辑 .env
文件,设置如下内容:
DB_URI=mongodb://localhost:27017/digitaldisplay
安装依赖
npm install
运行设置脚本
npm run setup
指定你的 MongoDB 数据库 URI。
启动项目
npm run dev
现在,你应该能够在浏览器中通过 http://localhost:3000
访问你的数字标牌系统。
3. 应用案例和最佳实践
添加新小工具
由于本软件的模块化结构,添加新的小工具非常简单。以下是一个简单的步骤指南:
- 在
widgets/
文件夹内创建一个新的文件夹,并以你的小工具名称命名。 - 在新文件夹内创建
index.js
文件,并继承base_widget
类。 - 实现两个 React 组件:
Widget
和Options
。 - 在
widgets/widget_list.js
文件中注册你的新小工具。 - 重启服务器以在管理员面板中查看新小工具。
灵活布局
利用内置的拖拽、放置和调整大小功能,你可以轻松地创建一个灵活且响应式的布局,以适应不同屏幕大小和显示需求。
4. 典型生态项目
目前,本项目支持以下内置小工具:
- 幻灯片小工具
- 天气小工具
- 恭喜信息小工具
- YouTube 嵌入小工具
- 网页(iframe)小工具
- 独立图像小工具
- 公告小工具
- 列表小工具
项目持续开发中,更多小工具和功能将不断加入。欢迎贡献你的代码和想法,共同打造更加完善的开源数字标牌解决方案。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考