forked from miemo/roon-web-controller
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path.cursorrules
93 lines (81 loc) · 2.28 KB
/
.cursorrules
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# Roon Web Controller 项目规范和结构
## 项目目录结构
```
roon-web-controller/
├── app.js # 主应用入口文件
├── public/ # 静态资源目录
│ ├── css/ # 样式文件
│ ├── js/ # JavaScript 文件
│ ├── img/ # 图片资源
│ ├── favicons/ # 网站图标
│ ├── nowplaying.html # 当前播放页面
│ ├── fullscreen.html # 全屏显示页面
│ └── side-by-side.html # 并排显示页面
├── config/ # 配置文件目录
├── docker-compose.yml # Docker 编排配置
├── Dockerfile # Docker 构建文件
├── package.json # 项目依赖配置
├── package-lock.json # 依赖版本锁定文件
├── README.md # 项目说明文档
├── CHANGELOG.md # 更新日志
└── LICENSE # 许可证文件
```
## 项目评估
### 1. 技术栈
- 后端:Node.js、Express、Socket.IO
- 前端:jQuery、HTML5、CSS3
- 部署:Docker
- API:Roon API
### 2. 代码质量要求
- 使用严格模式 ("use strict")
- 遵循 ESLint 规范
- 保持代码注释完整
- 使用语义化命名
- 错误处理规范化
### 3. 功能模块划分
- 核心控制模块 (app.js)
- 播放控制界面 (nowplaying.html)
- 全屏显示模块 (fullscreen.html)
- 多区域控制
- WebSocket 实时更新
### 4. 安全规范
- 定期更新依赖包
- 实现请求限流
- 添加安全性配置
- 使用 HTTPS
- 实现用户认证
### 5. 性能优化准则
- 资源缓存策略
- 图片加载优化
- 断线重连机制
- 性能监控实现
### 6. 部署规范
- Docker 容器化部署
- 环境配置分离
- 端口配置灵活
- 日志记录完整
- 健康检查机制
### 7. 文档要求
- README 更新及时
- API 文档完整
- 版本更新记录
- 部署文档详细
- 故障排除指南
### 8. 开发流程
- Git 版本控制
- 分支管理规范
- 代码审查流程
- 测试用例覆盖
- CI/CD 集成
### 9. 待优化项目
- 升级 Node.js 版本要求
- 更新过时依赖
- 添加单元测试
- 改进错误监控
- 完善文档系统
### 10. 维护责任
- 定期依赖更新
- 安全漏洞修复
- 性能监控和优化
- 用户反馈处理
- 文档同步更新