From 498e8f0e53de1484028f593a85a13cb6437d7fe7 Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Wed, 8 Jul 2026 04:52:30 +0000 Subject: [PATCH] Add README.md --- README.en.md | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 148 insertions(+) create mode 100644 README.en.md create mode 100644 README.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..93a29ae --- /dev/null +++ b/README.en.md @@ -0,0 +1,74 @@ +# Plural + +A data visualization and monitoring dashboard project for the energy metering field. + +## Project Overview + +Plural is a web-based energy dashboard application primarily designed to display and monitor electricity meter/energy metering data. As part of the Zero Carbon Initiative (lk-zero-carbon), this project enables users to monitor energy consumption in real time. + +## Key Features + +- **Multi-dimensional Metric Switching**: Supports tabs for different metering metrics +- **Time Period Selection**: Allows selection of various time ranges for data viewing +- **Hierarchical Filtering**: Supports filtering metering points by hierarchical structure +- **Key Performance Indicators (KPIs) Display**: + - Total number of metering points + - Number of data points + - Average value + - Latest value +- **Data Visualization**: Charts displaying trends in data curves +- **Data Tables**: Detailed tabular display of data +- **Data Source Configuration**: Flexible configuration panel for data sources + +## Technology Stack + +- **Frontend Framework**: Native HTML/CSS/JavaScript +- **Database**: TDEngine (time-series database) +- **Web Server**: Nginx + +## File Structure + +- `meter-curves.html` - Main page file containing the complete frontend interface +- `config.js` - Configuration file +- `nginx-static-tdengine.conf` - Nginx configuration (for TDEngine static service) +- `.gitignore` - Git ignore configuration + +## Quick Start + +### Prerequisites + +- Web browser (Chrome, Firefox, Edge, or other modern browsers) +- TDEngine database service +- Nginx web server + +### Deployment Steps + +1. Deploy project files to the web server directory +2. Configure database connection parameters in `nginx-static-tdengine.conf` +3. Modify the `config.js` configuration file according to your environment +4. Restart the Nginx service + +```bash +# Example: Copy Nginx configuration and restart +sudo cp nginx-static-tdengine.conf /etc/nginx/sites-available/ +sudo nginx -t +sudo systemctl restart nginx +``` + +## Usage Instructions + +1. Access the deployed page in your browser +2. Use the top toolbar to select the desired metric type +3. Choose a time period (day, week, month, year, etc.) +4. Use the hierarchical filter to select specific metering points +5. View detailed data in charts and tables +6. Adjust data source settings via the right-side configuration panel + +## Related Links + +- [TDEngine Documentation](https://www.taosdata.com/) +- [Zero Carbon Initiative](https://gitee.com/lk-zero-carbon) + +## License + +Please refer to the LICENSE file in this project for specific licensing terms. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..500e797 --- /dev/null +++ b/README.md @@ -0,0 +1,74 @@ +# Plural + +一个面向能源计量领域的数据可视化与监控仪表板项目。 + +## 项目简介 + +Plural 是一个基于 Web 的能源仪表盘应用,主要用于展示和监控电表/能源计量数据。该项目作为零碳计划(lk-zero-carbon)的一部分,帮助用户实时监测能源使用情况。 + +## 主要功能 + +- **多维度指标切换**:支持不同的计量指标选项卡 +- **时间周期选择**:可选择不同的时间范围进行数据查看 +- **层级筛选**:支持按层级结构筛选计量点 +- **关键指标(KPI)展示**: + - 计量点总数 + - 数据点数量 + - 平均值 + - 最新值 +- **数据可视化**:图表展示数据曲线变化趋势 +- **数据表格**:详细的数据表格展示 +- **数据源配置**:灵活的数据源配置面板 + +## 技术栈 + +- **前端框架**:原生 HTML/CSS/JavaScript +- **数据库**:TDEngine(时序数据库) +- **Web 服务器**:Nginx + +## 文件结构 + +- `meter-curves.html` - 主页面文件,包含完整的前端界面 +- `config.js` - 配置文件 +- `nginx-static-tdengine.conf` - Nginx 配置(TDEngine 静态服务) +- `.gitignore` - Git 忽略配置 + +## 快速开始 + +### 环境要求 + +- Web 浏览器(Chrome、Firefox、Edge 等现代浏览器) +- TDEngine 数据库服务 +- Nginx Web 服务器 + +### 部署步骤 + +1. 将项目文件部署到 Web 服务器目录 +2. 配置 `nginx-static-tdengine.conf` 中的数据库连接参数 +3. 根据实际环境修改 `config.js` 配置文件 +4. 重启 Nginx 服务 + +```bash +# 示例:复制 Nginx 配置并重启 +sudo cp nginx-static-tdengine.conf /etc/nginx/sites-available/ +sudo nginx -t +sudo systemctl restart nginx +``` + +## 使用说明 + +1. 在浏览器中访问部署的页面 +2. 通过顶部工具栏选择要查看的指标类型 +3. 选择时间周期(日、周、月、年等) +4. 使用层级筛选器选择特定的计量点 +5. 查看图表和表格中的详细数据 +6. 通过右侧配置面板调整数据源设置 + +## 相关链接 + +- [TDEngine 文档](https://www.taosdata.com/) +- [零碳计划](https://gitee.com/lk-zero-carbon) + +## 许可证 + +请查看项目中的 LICENSE 文件了解具体的许可协议。 \ No newline at end of file -- Gitee