Skip to content

A modern and elegant dashboard for network traffic visualization and analysis.

feat: add changelog files and update READMEs with links to them.

luoleief0826b2d473
diff --git a/CHANGELOG.en.md b/CHANGELOG.en.md
new file mode 100644
index 0000000..e4e50cf
--- /dev/null
+++ b/CHANGELOG.en.md
@@ -0,0 +1,160 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Time range restrictions for showcase mode stats display
+- Backend switching capability in showcase mode
+- Enhanced rule chain flow visualization with zero-traffic chain merging
+
+## [1.2.0] - 2026-02-12
+
+### Added
+- **Token-based Authentication System**
+ - New login dialog
+ - Auth Guard for route protection
+ - Corresponding backend authentication services
+- **Showcase Mode**
+ - Restrict backend operations and configuration changes
+ - URL masking for enhanced security
+ - Standardized forbidden error messages
+ - Improved access control checks
+- WebSocket token verification for secure real-time communication
+
+### Changed
+- Updated project description
+- Refined UI layouts for improved responsiveness
+- Added Windows detection hook
+
+## [1.1.0] - 2026-02-11
+
+### Changed
+- **Project Rebranding**: Renamed from "Clash Master" to "Neko Master"
+ - Updated all assets and branding materials
+ - Changed package scope from `@clashmaster` to `@neko-master`
+ - Cleanup of legacy references
+- Restructured web app components into `common`, `layout`, and `features` directories
+- Migrated API routes from monolithic `api.ts` to dedicated controllers
+- Introduced new `collector` service for backend data management
+
+### Added
+- Skeleton loading for better UX
+- Domain preview with copy functionality
+
+## [1.0.5] - 2026-02-07
+
+### Changed
+- **Upgraded to Next.js 16**
+- Migrated manifest to dynamic generation
+
+### Fixed
+- Ensured manifest is properly emitted in HTML head
+- Added dev image tags for Docker
+
+## [1.0.4] - 2026-02-08 ~ 2026-02-10
+
+### Added
+- **WebSocket Real-time Data Support**
+ - WebSocket push interval control
+ - Service worker caching for connection robustness
+ - Client-side push interval control
+- Country traffic list sorting (by traffic and connections)
+- `useStableTimeRange` hook for consistent time range handling
+- `keepPreviousByIdentity` query placeholder
+- `ExpandReveal` UI component
+- Auto-refresh spinning animation
+
+### Performance
+- Optimized WebSocket data payloads and push frequency
+- Improved GeoIP lookup efficiency through batching
+- Optimized rule chain flow rendering with component memoization
+- Throttled data updates for better performance
+- Conditional fetching based on active tab
+
+### Changed
+- Migrated data fetching to `@tanstack/react-query` for improved state management and caching
+- Enhanced Top Domains Chart with stacked traffic and self-fetching data
+- Added flag fonts for country/region display
+
+## [1.0.3] - 2026-02-07 ~ 2026-02-08
+
+### Added
+- **Interactive Rule Statistics**
+ - Paginated domain/IP tables
+ - Proxy chain tracking
+ - Zero-traffic rules display
+- **Device Statistics** with dedicated tables and backend collection
+- **IP Statistics** with detailed information
+- **Domain Statistics** with filtering capabilities
+- Time range filtering for interactive stats
+- `CountryFlag` component for visual country/region representation
+- Real-time traffic statistics collection
+- Zooming support in rule chain flow visualization
+- Custom date range display formatting
+- Calendar layout refactored to use CSS Grid
+
+### Changed
+- Refactored data cleanup to use minute-level statistics
+- Enhanced version status display in about dialog
+
+## [1.0.2] - 2026-02-06 ~ 2026-02-07
+
+### Added
+- **PWA (Progressive Web App) Support**
+ - Service worker implementation
+ - Manifest file
+ - PWA install functionality
+- **Interactive Proxy Statistics**
+ - Detailed domain and IP tables
+ - Sorting and pagination
+ - Per-proxy traffic breakdown
+- Database data retention management
+- Favicon provider selection
+- Docker health checks
+- Backend configuration verification
+- Toast notifications for better UX
+- About dialog with version information
+- API endpoint to test existing backend connections by ID
+
+### Changed
+- Standardized port environment variables across Dockerfile, docker-compose, and Next.js configuration
+- Added package.json version to Docker image tags
+- Automated Docker Hub description updates
+- Enhanced dashboard mobile experience for tables
+- Improved scrollbar and backend error handling UI
+
+### Infrastructure
+- Added CI/CD workflows
+ - Dev branch hygiene workflow
+ - Preview branch creation workflow
+ - Enhanced Docker image tagging strategy
+
+## [1.0.1] - 2026-02-06
+
+### Added
+- English README documentation
+- Language selection support in main README
+
+### Changed
+- Enhanced README with first-use setup screenshot
+- Updated README header styling with larger logo
+- Updated Docker deployment instructions to use pre-built images from Docker Hub
+
+## [1.0.0] - 2026-02-06
+
+### Added
+- Initial release of Clash Master
+- Modern traffic analytics dashboard for edge gateways
+- Real-time network traffic visualization
+- Backend management and configuration
+- Docker deployment support
+- Multi-backend support
+- Traffic statistics overview
+- Country traffic distribution
+- Proxy traffic statistics
+- Rule-based traffic analysis
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..12b93e5
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,160 @@
+# 更新日志
+
+本文档记录了本项目的所有重要变更。
+
+格式基于 [Keep a Changelog](https://keepachangelog.com/zh-CN/1.0.0/),
+并且本项目遵循 [语义化版本](https://semver.org/lang/zh-CN/spec/v2.0.0.html)。
+
+## [未发布]
+
+### 新增
+- 展示模式下的时间范围限制
+- 展示模式下支持后端切换
+- 增强规则链流可视化,支持合并零流量链
+
+## [1.2.0] - 2026-02-12
+
+### 新增
+- **基于 Token 的身份认证系统**
+ - 新增登录对话框
+ - 认证守卫 (Auth Guard)
+ - 对应的后端认证服务
+- **展示模式 (Showcase Mode)**
+ - 限制后端操作和配置更改
+ - URL 掩码保护,提升安全性
+ - 标准化的禁止访问错误提示
+ - 完善访问控制检查
+- WebSocket Token 验证,保障实时通信安全
+
+### 优化
+- 更新项目描述
+- 优化 UI 布局,提升响应式体验
+- 新增 Windows 系统检测 Hook
+
+## [1.1.0] - 2026-02-11
+
+### 变更
+- **项目品牌重塑**:从 "Clash Master" 更名为 "Neko Master"
+ - 更新所有素材和品牌标识
+ - 包作用域从 `@clashmaster` 更改为 `@neko-master`
+ - 清理遗留引用
+- 重构 Web 应用组件目录结构,划分为 `common`、`layout` 和 `features` 三个目录
+- 将 API 路由从单体 `api.ts` 迁移到专用控制器
+- 引入新的 `collector` 服务用于后端数据管理
+
+### 新增
+- 骨架屏加载效果,提升用户体验
+- 域名预览及一键复制功能
+
+## [1.0.5] - 2026-02-07
+
+### 变更
+- **升级至 Next.js 16**
+- 将 Manifest 迁移为动态生成
+
+### 修复
+- 确保 Manifest 正确输出到 HTML head
+- 添加 Docker 开发镜像标签
+
+## [1.0.4] - 2026-02-08 ~ 2026-02-10
+
+### 新增
+- **WebSocket 实时数据支持**
+ - WebSocket 推送间隔控制
+ - Service Worker 缓存,增强连接稳定性
+ - 客户端推送间隔控制
+- 国家流量列表排序(支持按流量和连接数排序)
+- `useStableTimeRange` Hook,确保时间范围一致性
+- `keepPreviousByIdentity` 查询占位符
+- `ExpandReveal` UI 组件
+- 自动刷新旋转动画
+
+### 性能优化
+- 优化 WebSocket 数据包大小和推送频率
+- 通过批量处理提升 GeoIP 查询效率
+- 使用组件记忆化优化规则链流渲染
+- 节流数据更新,降低性能开销
+- 基于活跃标签页的按需数据获取
+
+### 变更
+- 将数据获取迁移至 `@tanstack/react-query`,改善状态管理和缓存
+- 增强 Top Domains 图表,支持堆叠流量和自获取数据
+- 添加国旗字体,优化国家/地区展示
+
+## [1.0.3] - 2026-02-07 ~ 2026-02-08
+
+### 新增
+- **交互式规则统计**
+ - 支持分页的域名/IP 表格
+ - 代理链追踪
+ - 零流量规则展示
+- **设备统计** - 专用表格和后端采集
+- **IP 统计** - 详细信息展示
+- **域名统计** - 支持筛选功能
+- 交互式统计的时间范围过滤
+- `CountryFlag` 组件,可视化展示国家/地区
+- 实时流量统计采集
+- 规则链流可视化支持缩放
+- 自定义日期范围显示格式
+- 日历布局重构为 CSS Grid 实现
+
+### 变更
+- 数据清理重构为使用分钟级统计
+- 优化关于对话框中的版本状态展示
+
+## [1.0.2] - 2026-02-06 ~ 2026-02-07
+
+### 新增
+- **PWA(渐进式 Web 应用)支持**
+ - Service Worker 实现
+ - Manifest 配置文件
+ - PWA 安装功能
+- **交互式代理统计**
+ - 详细的域名和 IP 表格
+ - 排序和分页功能
+ - 单代理流量分解
+- 数据库数据保留管理
+- Favicon 提供商选择
+- Docker 健康检查
+- 后端配置验证
+- Toast 通知,提升交互体验
+- 关于对话框,展示版本信息
+- API 端点:按 ID 测试现有后端连接
+
+### 变更
+- 标准化 Dockerfile、docker-compose 和 Next.js 配置中的端口环境变量
+- Docker 镜像标签添加 package.json 版本号
+- 自动化 Docker Hub 描述更新
+- 优化仪表板移动端表格体验
+- 改进滚动条和后端错误处理 UI
+
+### 基础设施
+- 新增 CI/CD 工作流
+ - 开发分支清理工作流
+ - 预览分支创建工作流
+ - 增强 Docker 镜像标签策略
+
+## [1.0.1] - 2026-02-06
+
+### 新增
+- 英文 README 文档
+- 主 README 支持语言选择
+
+### 变更
+- 添加首次使用设置截图,丰富 README 内容
+- 更新 README 头部样式,使用更大的 Logo
+- 更新 Docker 部署文档,推荐使用 Docker Hub 预构建镜像
+
+## [1.0.0] - 2026-02-06
+
+### 新增
+- Clash Master 初始版本发布
+- 现代化的边缘网关流量分析仪表板
+- 实时网络流量可视化
+- 后端管理和配置
+- Docker 部署支持
+- 多后端支持
+- 流量统计概览
+- 国家/地区流量分布
+- 代理流量统计
+- 基于规则的流量分析
diff --git a/README.md b/README.md
index c5bc44f..5bb27f1 100644
--- a/README.md
+++ b/README.md
@@ -54,6 +54,7 @@ Neko Master 专注于对网络流量进行轻量、精确的分析与可视化
- [❓ 常见问题](#-常见问题)
- [📁 项目结构](#-项目结构)
- [🛠️ 技术栈](#️-技术栈)
+- [📝 更新日志](./CHANGELOG.md)
- [📄 许可证](#-许可证)
## 🚀 快速开始
diff --git a/README_EN.md b/README_EN.md
index 9d81097..85abfd6 100644
--- a/README_EN.md
+++ b/README_EN.md
@@ -48,6 +48,7 @@ Just like a cat—quiet yet keen—Neko Master focuses on lightweight, precise a
- [❓ FAQ](#-faq)
- [📁 Project Structure](#-project-structure)
- [🛠️ Tech Stack](#️-tech-stack)
+- [📝 Changelog](./CHANGELOG.en.md)
- [📄 License](#-license)
## 🚀 Quick Start