Workhelper - 个人工作效率工具

一个无需登录的工作效率工具，包含 TODO、会议记录、网页书签三大模块，并提供 AI 总结能力。

技术栈

• 后端：Golang (Gin) + GORM + MySQL 8.x
• 前端：Vue 3 + TypeScript + Vite + Element Plus
• 数据库：MySQL 8.x

功能特性

TODO 模块

• 日计划/周计划管理
• 完成度打卡
• 统计汇总（日/周/月视图）
• 日报/周报生成
• AI 聊天提炼（占位实现）

会议记录模块

• 会议纪要创建与管理
• 会议日历视图
• 会议统计

网页书签模块

• 分类管理
• 书签卡片展示
• 快捷打开

其他

• Notion 风格界面
• 响应式布局
• 深色模式支持

项目结构

Workhelper/
├── backend/              # 后端服务
│   ├── cmd/server/      # 入口文件
│   ├── internal/
│   │   ├── api/         # API 路由层
│   │   ├── service/     # 业务逻辑层
│   │   ├── repository/  # 数据访问层
│   │   ├── model/       # 数据模型
│   │   └── integration/ # 集成层
│   ├── configs/         # 配置文件
│   └── migrations/      # 数���库迁移
└── frontend/            # 前端应用
    └── src/
        ├── views/       # 页面组件
        ├── components/  # 公共组件
        ├── stores/      # 状态管理
        ├── api/         # API 请求
        └── router/      # 路由配置

快速开始

前置要求

• Node.js 18+
• Go 1.21+ （注意：当前系统为 Go 1.17，需要升级）
• MySQL 8.x

数据库初始化

1. 创建数据库并执行初始化脚本：

# 方法 1：使用 MySQL 命令行
mysql -u root -p < backend/migrations/init.sql

# 方法 2：使用 MySQL Workbench
# 打开 backend/migrations/init.sql 并执行

2. 默认数据库配置：
   • 主机：localhost:3306
   • 用户：root
   • 密码：wenqiang
   • 数据库：workhelper

后端启动

1. 安装依赖：

cd backend
go mod tidy

注意：如果遇到 Go 版本问题，请：

# 升级 Go 到 1.21+ 版本
# 或使用兼容的依赖版本
go get -u github.com/gin-gonic/gin@v1.9.1
go get -u gorm.io/gorm@v1.25.5

2. 启动服务：

go run cmd/server/main.go

后端服务将运行在 http://localhost:8080

前端启动

1. 安装依赖（已完成）：

cd frontend
npm install

2. 启动开发服务器（已完成）：

npm run dev

前端服务运行在 http://localhost:5173

开发进度

✅ 第1周：项目基础架构

• 初始化项目结构
• 数据库建表脚本
• 后端基础框架
• 前端基础框架
• 基础布局和路由

🔄 第2周：TODO 核心功能

• TODO CRUD 接口测试
• TODO 前端页面完善
• 完成度打卡功能
• 日报/周报功能

⏳ 第3周：会议与书签模块

• 会议 CRUD 接口
• 会议日历视图
• 书签管理���能

⏳ 第4周：高级功能与收尾

• 定时提醒功能
• AI 功能集成
• 整体测试与优化

配置说明

后端配置

配置文件位于 backend/configs/config.yaml：

server:
  port: 8080
  mode: debug  # debug, release, test

database:
  host: localhost
  port: 3306
  user: root
  password: wenqiang
  dbname: workhelper

ai:
  enabled: false  # AI 功能暂未启用

前端配置

• Vite 代理配置：frontend/vite.config.ts
• 路由配置：frontend/src/router/index.ts
• API 配置：frontend/src/api/request.ts

API 文档

TODO 模块

• GET /api/todos - 获取 TODO 列表
• POST /api/todos - 创建 TODO
• PUT /api/todos/:id - 更新 TODO
• DELETE /api/todos/:id - 删除 TODO
• POST /api/todos/:id/checkin - 完成度打卡
• GET /api/todos/summary - 统计汇总

会议模块

• GET /api/meetings - 获取会议列表
• POST /api/meetings - 创建会议
• PUT /api/meetings/:id - 更新会议
• DELETE /api/meetings/:id - 删除会议

书签模块

• GET /api/bookmarks/categories - 获取分类
• POST /api/bookmarks/categories - 创建分类
• GET /api/bookmarks - 获取书签列表
• POST /api/bookmarks - 创建书签

常见问题

1. Go 版本问题

如果遇到 package xxx is not in GOROOT 错误，说明 Go 版本过低。解决方案：

# 下载 Go 1.21+ 并安装
# 或使用旧版本依赖
go get -u github.com/gin-gonic/gin@v1.7.7

2. 数据库连接失败

检查：

• MySQL 服务是否启动
• 配置文件中的密码是否正确
• 数据库是否已创建

3. 前端跨域问题

前端已配置 Vite 代理，API 请求会自动转发到后端。

贡献指南

1. Fork 本项目
2. 创建特性分支 (git checkout -b feature/AmazingFeature)
3. 提交更改 (git commit -m 'Add some AmazingFeature')
4. 推送到分支 (git push origin feature/AmazingFeature)

许可证

MIT License

联系方式

如有问题，请提交 Issue。