用 waka-box 展示你的编程风采
项目介绍
你是否想过在 GitHub 上展示你的编程习惯和技能?waka-box
是一个开源项目,它能够自动更新你 GitHub 上的一个固定 Gist,展示你每周的 WakaTime 统计数据。WakaTime 是一个用于跟踪编程活动的工具,而 waka-box
则将这些数据以可视化的方式呈现在你的 GitHub 个人资料中,让你的编程习惯一目了然。
项目技术分析
waka-box
项目主要依赖于 GitHub Actions 和 WakaTime API。通过 GitHub Actions,项目能够定时触发更新操作,而 WakaTime API 则提供了用户的编程统计数据。项目的技术栈包括:
- GitHub Actions: 用于自动化任务调度,确保每周自动更新 Gist。
- WakaTime API: 获取用户的编程统计数据,包括编程时间、使用的语言、编辑器等。
- GitHub Gist: 用于存储和展示统计数据。
项目及技术应用场景
waka-box
适用于以下场景:
- 开发者个人展示: 开发者可以在 GitHub 上展示自己的编程习惯和技能,吸引潜在雇主或合作伙伴的注意。
- 开源社区贡献: 开源项目维护者可以通过展示自己的编程时间,证明对项目的持续贡献。
- 编程学习者: 学习编程的学生或新手可以通过展示自己的编程时间,激励自己持续学习。
项目特点
- 自动化更新: 通过 GitHub Actions,项目能够自动定时更新 Gist,无需手动操作。
- 数据可视化: 通过 WakaTime API 获取的数据以简洁的方式展示在 Gist 中,便于查看。
- 易于配置: 项目配置简单,只需几个步骤即可完成设置,适合各种技术水平的用户。
- 开源社区支持: 项目开源,社区成员可以贡献代码,改进功能,增加新的特性。
如何开始
- 创建 Gist: 在 GitHub 上创建一个新的公共 Gist。
- 生成 Token: 在 GitHub 上生成一个带有
gist
权限的 Token。 - 注册 WakaTime: 注册一个 WakaTime 账户,并确保在设置中开启公开显示编程活动。
- 配置项目:
- 克隆或 Fork 本项目。
- 在
.github/workflows/schedule.yml
文件中配置环境变量。 - 在 GitHub 仓库的 Settings > Secrets 中添加
GH_TOKEN
和WAKATIME_API_KEY
。
通过以上步骤,你就可以轻松地在 GitHub 上展示你的编程风采了。快来试试吧!