完善README

This commit is contained in:
CN-JS-HuiBai
2026-04-05 15:03:50 +08:00
parent e7b8000808
commit 2149aa0208

View File

@@ -17,6 +17,7 @@
- Node.js >= 16 - Node.js >= 16
- MySQL >= 5.7 - MySQL >= 5.7
- Valkey >= 7.0 (或 Redis >= 6.0)
### 2. 配置 ### 2. 配置
@@ -26,22 +27,28 @@
cp .env.example .env cp .env.example .env
``` ```
编辑 `.env` 文件,配置 MySQL 连接信息: 编辑 `.env` 文件,配置 MySQL 和 Valkey 连接信息:
```env ```env
# MySQL 配置
MYSQL_HOST=localhost MYSQL_HOST=localhost
MYSQL_PORT=3306 MYSQL_PORT=3306
MYSQL_USER=root MYSQL_USER=root
MYSQL_PASSWORD=your_password MYSQL_PASSWORD=your_password
MYSQL_DATABASE=display_wall MYSQL_DATABASE=display_wall
# Valkey/Redis 缓存配置 (可选)
VALKEY_HOST=localhost
VALKEY_PORT=6379
VALKEY_PASSWORD=
VALKEY_TTL=30
PORT=3000 PORT=3000
``` ```
### 3. 初始化数据库 ### 3. 系统初始化
```bash 访问 `http://localhost:3000/init.html`,按照引导完成数据库和缓存的初始化。
npm run init-db
```
### 4. 安装依赖并启动 ### 4. 安装依赖并启动
@@ -73,7 +80,8 @@ scrape_configs:
## 技术栈 ## 技术栈
- **后端**: Node.js + Express - **后端**: Node.js + Express
- **数据库**: MySQL (mysql2) - **数据库**: MySQL (存储配置数据)
- **缓存**: Valkey / Redis (用于加速流量计算结果读取)
- **数据源**: Prometheus HTTP API - **数据源**: Prometheus HTTP API
- **前端**: 原生 HTML/CSS/JavaScript - **前端**: 原生 HTML/CSS/JavaScript
- **图表**: 自定义 Canvas 渲染 - **图表**: 自定义 Canvas 渲染