mod

readme

Author: wangle201210

README.md

@@ -1,200 +1,193 @@
-# KeyView - 键盘使用历史记录查看工具
+# KeyView
 
-基于 Wails v3.0.0-alpha.51 + Vue3 + github.com/wangle201210/keylogger + SQLite3 实现的键盘使用历史记录查看工具。
+<div align="center">
 
-## 功能特性
+**键盘使用历史记录查看工具**
 
-- 🔤 **实时键盘监听** - 记录所有键盘按键事件
-- 💾 **SQLite 数据存储** - 持久化存储键盘历史记录
-- 🔍 **强大的筛选功能** - 按按键名称、日期、动作类型筛选
-- 📊 **统计分析** - 显���总记录数、今日按键次数等统计信息
-- 🎨 **现代化 UI** - 基于 Vue3 构建的渐变风格界面
-- ⚡ **高性能** - 支持分页显示，流畅浏览大量记录
+基于 Wails v3 + Vue3 + SQLite3 构建的现代化键盘按键记录与分析工具
 
-## 技术栈
+[![Go Version](https://img.shields.io/badge/Go-1.24+-00ADD8?style=flat&logo=go)](https://golang.org/)
+[![Vue Version](https://img.shields.io/badge/Vue-3.0+-4FC08D?style=flat&logo=vue.js&logoColor=white)](https://vuejs.org/)
+[![License](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
+
+</div>
+
+## ✨ 功能特性
+
+- **🔤 实时键盘监听** - 自动记录所有键盘按键事件
+- **💾 SQLite 数据存储** - 持久化存储，轻量高效
+- **🔍 强大筛选功能** - 按按键名称、日期、动作类型灵活筛选
+- **📊 数据统计分析** - 实时显示总记录数、今日按键次数
+- **🎨 现代化 UI** - 基于 Vue3 + Element Plus 的美观界面
+- **⚡ 高性能** - 分页显示，流畅处理大量数据
+
+## 📸 应用截图
+
+![KeyView 界面](image/key-view.jpg)
+
+## 🛠️ 技术栈
 
 ### 后端
-- **Go 1.24+** - 主要编程语言
+- **Go 1.24+** - 核心编程语言
 - **Wails v3.0.0-alpha.51** - 桌面应用框架
-- **github.com/wangle201210/keylogger** - 键盘事件监听库
+- **github.com/wangle201210/keylogger** - 键盘事件监听
 - **GORM + SQLite3** - 数据库 ORM
 
 ### 前端
 - **Vue 3** - 渐进式 JavaScript 框架
-- **Vite** - 快速的前端构建工具
-
-## 项目结构
-
-```
-keyview/
-├── main.go              # 应用入口
-├── internal/
-│   └── app/
-│       └── service.go   # 后端服务实现
-├── frontend/            # Vue3 前端
-│   ├── src/
-│   │   ├── App.vue     # 主应用组件
-│   │   ├── main.js     # 前端入口
-│   │   ├── style.css   # 全局样式
-│   │   └── services/
-│   │       └── wails.js # Wails API 封装
-│   ├── index.html
-│   ├── package.json
-│   └── vite.config.js
-├── go.mod
-├── go.sum
-├── Makefile
-└── README.md
-```
+- **Element Plus** - Vue 3 UI 组件库
+- **Vite** - 快速构建工具
 
-## 安装与运行
+## 📦 安装与运行
 
 ### 前置要求
 
 - Go 1.24 或更高版本
 - Node.js 18+ 和 npm
-- macOS (目前仅支持 macOS 平台)
-- Xcode 命令行工具 (用于编译 C 代码)
+- macOS 系统
+- Xcode 命令行工具
 
-### 安装依赖
+### 快速开始
 
-1. 克隆项目（包括 keylogger 子模块）:
+1. **克隆项目**
 ```bash
 git clone --recurse-submodules <repository-url>
 cd keyview
 ```
 
-2. 安装前端依赖:
+2. **安装依赖**
 ```bash
+# 安装前端依赖
 make frontend-install
-# 或
-cd frontend && npm install
-```
 
-3. 下载 Go 依赖:
-```bash
+# 安装 Go 依赖
 go mod tidy
 ```
 
-### 运行应用
-
-#### 方式一：使用 Makefile
-
+3. **运行应用**
 ```bash
-# 构建前端并运行应用
 make run
-
-# 或者分步执行
-make frontend-build  # 构建前端
-make build          # 构建应用
-./keyview          # 运行
-```
-
-#### 方式二：手动执行
-
-```bash
-# 1. 构建前端
-cd frontend
-npm run build
-cd ..
-
-# 2. 构建并运行应用
-go build -o keyview
-./keyview
 ```
 
 ### 开发模式
 
-仅开发前端（热重载）:
 ```bash
-cd frontend
-npm run dev
+# 开发前端（支持热重载）
+cd frontend && npm run dev
+
+# 完整开发模式
+make dev
 ```
 
-前端开发服务器将在 `http://localhost:5173` 启动。
+## 📖 使用说明
 
-## 使用说明
+### 基本操作
 
-1. **启动应用** - 运行应用后会自动打开窗口
-2. **开始记录** - 点击"开始记录"按钮开始监听键盘事件
-3. **查看记录** - 所有按键事件会实时显示在列表中
-4. **筛选数据** - 使用顶部筛选栏按条件过滤记录
-5. **停止记录** - 点击"停止记录"按钮暂停监听
+1. **启动应用** - 运行后自动打开主窗口
+2. **开始记录** - 点击"开始记录"按钮监听键盘事件
+3. **查看数据** - 实时查看按键历史记录
+4. **筛选记录** - 使用筛选器查找特定记录
+5. **停止记录** - 点击"停止记录"暂停监听
 
 ### 筛选功能
 
-- **按键筛选** - 选择特定的按键名称查看其历史记录
-- **日期筛选** - 按日期查看特定日期的记录
-- **动作筛选** - 选择"按下"或"释放"查看特定动作
+- **按键筛选** - 选择特定按键查看其历史
+- **日期筛选** - 按日期查看记录
+- **动作筛选** - 筛选"按下"或"释放"事件
 
-### 数据统计
+### 统计信息
 
-- **总记录数** - 数据库中存储的总记录数量
-- **今日按键** - 今天按下的按键次数（仅计算按下事件）
+- **总记录数** - 数据库中的总记录数量
+- **今日按键** - 今日按键次数（仅统计按下事件）
 
-## 隐私说明
+## 📂 项目结构
 
-⚠️ **重要提示**：
-- 本工具仅用于个人使用统计和分析目的
-- 键盘记录数据存储在本地 SQLite 数据库中
-- 请勿将此工具用于恶意目的或未经授权的监控
-- 建议定期清理旧的记录数据
+```
+keyview/
+├── main.go              # 应用入口
+├── internal/
+│   └── app/
+│       └── service.go   # 后端服务
+├── frontend/            # Vue3 前端
+│   ├── src/
+│   │   ├── App.vue     # 主组件
+│   │   ├── main.js     # 前端入口
+│   │   └── services/   # API 服务
+│   └── package.json
+├── image/              # 截图和资源
+├── go.mod
+├── Makefile
+└── README.md
+```
 
-## 数据存储位置
+## 🔒 隐私与安全
 
-数据库文件默认存储在应用运行目录下的 `keyview.db` 文件中。
+⚠️ **重要提示**
 
-## 权限要求
+- 本工具仅供个人使用统计和分析
+- 所有数据存储在本地 SQLite 数据库
+- 请勿用于未经授权的监控
+- 建议定期清理历史数据
+
+### 数据存储位置
+
+数据库文件：`keyview.db`（应用运行目录）
+
+### macOS 权限设置
+
+键盘监听需要辅助功能权限：
 
-在 macOS 上运行键盘监听需要辅助功能权限：
 1. 打开"系统设置" > "隐私与安全性" > "辅助功能"
-2. 添加 `keyview` 应用到允许列表
+2. 添加 KeyView 到允许列表
 3. 重启应用
 
-## 故障排除
+## 🔧 常见问题
 
 ### 构建失败
 
-如果遇到 CGO 相关错误，确保已安装 Xcode 命令行工具：
+安装 Xcode 命令行工具：
 ```bash
 xcode-select --install
 ```
 
-### 权限被拒绝
+### 权限问题
 
-如果在启动时遇到权限错误，请按照上述步骤授予辅助功能权限。
+按上述步骤授予辅助功能权限
 
-### 前端无法加载
+### 前端未构建
 
-确保前端已经构建：
 ```bash
 cd frontend && npm run build
 ```
 
-## 开发
-
-### 代码格式化
+## 📝 Make 命令
 
 ```bash
-make fmt
+make run           # 运行应用
+make build         # 构建应用
+make clean         # 清理构建文件
+make fmt           # 格式化代码
+make frontend-build   # 构建前端
+make frontend-install # 安装前端依赖
 ```
 
-### 清理构建文件
+## 🤝 贡献
 
-```bash
-make clean
-```
-
-## 许可证
-
-请参考项目的 LICENSE 文件。
+欢迎提交 Issue 和 Pull Request！
 
-## 贡献
+## 📄 许可证
 
-欢迎提交 Issue 和 Pull Request！
+本项目采用 MIT 许可证 - 详见 [LICENSE](LICENSE) 文件
 
-## 致谢
+## 🙏 致谢
 
 - [Wails](https://wails.io/) - 优秀的 Go 桌面应用框架
 - [Vue.js](https://vuejs.org/) - 渐进式 JavaScript 框架
+- [Element Plus](https://element-plus.org/) - 优秀的 Vue 3 组件库
 - [GORM](https://gorm.io/) - Go 的 ORM 库
+
+---
+
+<div align="center">
+Made with ❤️ by KeyView Team
+</div>

go.mod

@@ -2,11 +2,11 @@ module github.com/wangle201210/keyview
 
 go 1.24.10
 
-replace github.com/wangle201210/keylogger => ../keylogger
+//replace github.com/wangle201210/keylogger => ../keylogger
 
 require (
 	github.com/wailsapp/wails/v3 v3.0.0-alpha.51
-	github.com/wangle201210/keylogger v0.0.0-00010101000000-000000000000
+	github.com/wangle201210/keylogger v0.0.0-20260107031629-7bcdca19b872
 	gorm.io/driver/sqlite v1.6.0
 	gorm.io/gorm v1.31.1
 )

go.sum

@@ -111,6 +111,8 @@ github.com/wailsapp/mimetype v1.4.1 h1:pQN9ycO7uo4vsUUuPeHEYoUkLVkaRntMnHJxVwYhw
 github.com/wailsapp/mimetype v1.4.1/go.mod h1:9aV5k31bBOv5z6u+QP8TltzvNGJPmNJD4XlAL3U+j3o=
 github.com/wailsapp/wails/v3 v3.0.0-alpha.51 h1:n8KT0H4lvtWld9tMIiHVX4nrR0wEMT2zy5hM/R6luMU=
 github.com/wailsapp/wails/v3 v3.0.0-alpha.51/go.mod h1:yaz8baG0+YzoiN8J6osn0wKiEi0iUux0ZU5NsZFu6OQ=
+github.com/wangle201210/keylogger v0.0.0-20260107031629-7bcdca19b872 h1:Za0FzgKw/bHv+j3MgwY4LVaWwfwrThVlIpCKVcC5Y6A=
+github.com/wangle201210/keylogger v0.0.0-20260107031629-7bcdca19b872/go.mod h1:4sODf3tM5s9gDa1VWmq9T6IgSuqScBX+BuNTapWBUTs=
 github.com/xanzy/ssh-agent v0.3.3 h1:+/15pJfg/RsTxqYcX6fHqOXZwwMP+2VyYWJeWM2qQFM=
 github.com/xanzy/ssh-agent v0.3.3/go.mod h1:6dzNDKs0J9rVPHPhaGCukekBHKqfl+L3KghI1Bc68Uw=
 golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=