Code Monkey home page Code Monkey logo

wakatime-sync's Introduction

wakatime-sync

quick start

简介

  • 更新 mysql 版本到 8.0
  • 此版本的 Dockerfile 使用分阶段构建,不需要宿主机安装 maven 环境

构建方法

  1. 使用 sql/wakatime_sync.sql 文件创建需要的表格
  2. 从模板复制一份你自己的配置文件,在 application.yml 文件中补全 api-key 等信息
cp src/main/resources/application.example.yml src/main/resources/application.yml
  1. 根据实际情况,修改 src/main/resources/templates/dashboard.html 文件中的 START_DAY 的值
  2. 构建你自己的镜像
cd wakatime-sync \
&& docker build -t wakatime-sync .
  1. 启动它,其中 /var/www/log 文件夹,用于保存日志文件 server.log
docker run -d \
-v /your/path/to/log:/var/www/log \
-p <your-port>:3040 \
--name wakatime \
wakatime-sync
  1. 此项目每天都会自动爬取前一天的记录。如果需要导入历史数据,你可以手动调用项目的接口:
curl -X POST http://<your-domain>:<your-port>/api/v1/sync \
-d day=<sync-days-num> \
-d apiKey=<your-wakatime-api-key>

注意事项

jdbc:mysql://<mysql-ip>:<mysql-port>/<mysql-db>?characterEncoding=utf8&...
  1. 数据库使用 jdbc 进行通信。在上述的 jdbc-url 中,如果 <mysql-ip> 填写 localhost 或者 127.0.0.1 是无法指向宿主机的,建议直接使用公网 IP。如果你没有公网 IP,网上也有相关的解决方案。当然,如果你使用 docker-compose<mysql-ip> 填写 mysql 服务的名称即可。

  2. 使用 jre 或者 jdk 的镜像,oracle 可能会要求使用者进行一些验证,详见:

https://blog.csdn.net/wengyupeng/article/details/87897866


以下为原项目的 README

WakaTime简介

WakaTime 是一款可以记录你的编码时间的工具,目前支持绝大部分主流的 IDE 以及 Chrome 浏览器。

使用步骤

  1. 注册 WakaTime 账号;
  2. 官网找到对应的 IDE 插件,按照步骤安装 WakaTime 插件(下图中灰色表示目前官方还不支持): 所支持的IDE
  3. 个人设置页面复制 Secret API Key ,填入对应的 WakaTime 插件中; 复制 Secret API Key
  4. 过一段时间后,你就可以在 WakaTime 网站上看到你的编码情况,如下图所示:

wakatime-sync项目

项目简介

WakaTime 提供了丰富多样的图表可以多维度地查看自己的编码时间情况。不过作为免费用户,最多只能查看自己最近14天的数据;如果要查看全部的数据,需要 $9/月的订阅费用。

还好 WakaTime 提供了 API 接口,通过接口可以获取到编码时间统计情况的原始数据(作为免费用户还是有只能查看最近14天数据的限制)。

本项目通过 WakaTime 提供的 API 接口,可以把自己的 WakaTime 数据保存在的数据库中,然后利用图表插件展示出来,目前已完成三种类型的图表展示:

  • 每日项目持续时间图: 每日项目持续时间图
  • 时间范围内活动情况: 时间范围内活动情况
  • 每日编码耗时日历图: 每日编码耗时日历图

项目地址

所用技术

后端:JDK1.8、SpringBoot、Jodd-HTTP、Thymeleaf;

数据库:MySQL 5.7;

前端:Moment.js、ElementUI、AntV-G2 、Echarts;

通知服务:Server酱钉钉机器人

项目逻辑比较简单,就是每天会定时通过 WakaTime 的 API 抓取并保存前一天的数据,再通过图标插件展示出来。之后还会完善接口缓存、同步通知等功能;

同时使用了 AntV-G2 和 Echarts 的原因是因为持续时间图可以用 AntV-G2 实现,但日历图用 AntV-G2 实现过于复杂,就采用了用 Echarts 实现日历图;

另外本项目最初是的数据库是 MongoDB ,但是考虑到通用性和易用性后来又换成了 MySQL。MongoDB 版本的代码也实现了相关的同步展示逻辑,代码在 mongodb 分支中。

使用方法

替换或设置好src/main/resources/application.yml配置文件中的wakatime.app.keyspring.datasource.* 相关数据库配置,采用 maven 打包的方式安装即可,支持 Docker 方式安装。

数据库建库脚本位于sql/wakatime_sync.sql中。

数据库使用 MongoDB 的版本位于分支 mongdb 中。

示例地址:https://wakatime.wangfeng.pro/

消息通知

系统中有一个定时任务,会在每天早上09:00会根据配置信息想钉钉或微信发送上一天的编码时间信息; 需要在application.yml配置对应的参数:

  • Server酱微信通知:按照Server酱网站说明获得一个SCKEY,设置成wakatime.ftqq-key的值;
  • 钉钉机器人通知:在要获得提醒的钉钉群里面生成一个自定义机器人,将机器人的 Hook 地址中的 access_token 的值设置成wakatime.dingding-key的值;

如果不想使用对应的消息通知,请将application.yml中对应的参数注释掉或将值置为空

可能会遇到的问题

  1. 由于本项目采用的是SpringBoot 2,对应的 mysql-connector-java 驱动使用的是MySQL服务端的时区,如果你使用的MySQL的时区和你程序中的时区以及你在 WakaTime 个人设置中的时区不一致,就会导致保存的相关数据中时间不准,解决办法就是首先调整好 WakaTime 个人设置里的时区,再调整 MySQL 数据库的时区,或者是使用 5.X版本的mysql-connector-java驱动。
  2. 如果你一直在使用 WakaTime ,如果想使用本项目同步你所有的历史数据,可以在官网上试用团队版的方式获得1个月(还是半个月?)的付费版功能或者是订阅一个月的付费版,然后通过本项目来同步所有的历史数据:POST /api/v1/sync 或参见项目中的测试方法。使用测试方法进行时不能同时使用太多的线程去同时调用 API 接口,会被限流。

TODO

  • 昨日编码消息消息通知;
  • 查询接口缓存;
  • 可以对项目名称设置别名展示;

更新记录

2019-02-08

  • 添加获取 wakatime api 数据接口的代理配置,解决 Wakatime 网站被墙导致无法获取接口数据的问题;

2019-02-02

  • 新增图表交互:点击Activity或Calendar图指定日期的数据时,Duration图会显示对应日期的数据;

2019-01-23

  • 页面优化:修改时间区间选择器在移动端的位置;

2019-01-20

  • 活动图中如果某天没数据,可以选择是否要用空数据填充;
  • 接口参数校验;
  • bugfix: 某天无数据发送消息时的空指针错误

2019-01-17

  • 修改图表中坐标轴的文字颜色为与背景颜色区分较大的白色;
  • 持续时间图当天没数据时不显示图表结构;
  • 新增了定时任务:每天早上09:00会根据配置信息想钉钉或微信发送上一天的编码时间信息;

wakatime-sync's People

Contributors

wf2311 avatar qwelzqwelz avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.