WhatGotDone 开源项目指南

WhatGotDone 开源项目指南

whatgotdoneA tool for sharing weekly task updates with teammates.项目地址:https://gitcode.com/gh_mirrors/wh/whatgotdone

1. 项目介绍

WhatGotDone 是一款专为团队设计的工具，用于分享每周的任务更新。它拥有简洁的架构，包括以下几个核心部分：一个用 Go 语言编写的后端服务来处理所有HTTP请求、数据存储操作以及通过UserKit进行用户认证；一个基于Vue2的前端应用程序，负责在用户的浏览器中渲染页面；以及SQLite作为存储提供者，可选地，通过Litestream同步SQLite数据库至云端存储。此外，用户认证则委托给第三方服务UserKit管理。

2. 快速启动

要迅速体验WhatGotDone，遵循以下步骤：

首先，确保您已安装了必要的软件包，包括Node.js (v18.x及以上)，Go (v1.19及以上)，Docker（用于端到端测试），以及Google Cloud SDK（如需启用图片上传）。

使用Docker容器运行

1. 克隆项目仓库：

   git clone https://github.com/mtlynch/whatgotdone.git
   

2. 在项目根目录下运行Docker Compose以启动服务：

   docker-compose up
   

完成上述步骤后，WhatGotDone将部署并运行在http://localhost:3001。开发模式下的身份验证采用UserKit的模拟模式，允许任意用户名通过密码password登录。

手动本地设置（开发者环境）

对于更深度的开发或调试需求，可执行以下命令：

• 安装依赖并启动热重载服务器：

  cd /path/to/whatgotdone
  ./dev-scripts/serve
  

这将同时构建Vue前端，启动后端及前端的热重载服务器。

3. 应用案例和最佳实践

虽然没有特定的应用案例详述，但WhatGotDone最适合于那些希望提升团队透明度，简化周报流程的组织。最佳实践建议包括：

• 周期性更新：团队成员应养成每周固定时间总结和发布任务进展的习惯。
• 清晰沟通：利用WhatGotDone的文本编辑器，详细记录每个任务的状态，可能遇到的问题及解决思路。
• 反馈文化：鼓励同事间查看和评论彼此的工作周报，促进协作和知识共享。

4. 典型生态项目

由于提供的信息不包含关于“典型生态项目”的具体细节，无法列出具体的关联或生态系统项目。然而，可以推测，其生态可能会围绕API集成（比如与项目管理和时序分析工具的集成）、定制化的插件或扩展（如与GitLab、Jira等的互操作性），以及可能的社区贡献的增强功能。开发者可以探索集成其他云存储解决方案或身份验证服务以适应不同需求。

---

请注意，上述快速启动指令是基于提供的GitHub仓库概述编写的概括性指导，并假设用户已有一定的技术背景和基本的开发环境配置。实际操作时，请参考项目最新文档和说明，以防有变更。

whatgotdoneA tool for sharing weekly task updates with teammates.项目地址:https://gitcode.com/gh_mirrors/wh/whatgotdone