Wakatime-Leaderboards📶

Automated WakaTime Leaderboards for your GitHub Profile

---

Prerequisites

1. Wakatime API Key: API key is required to fetch your account details. Get your API key from here.
2. Markdown Comments: Update the markdown file by adding the comments where your Wakatime Leaderboard Stats will be embedded to. Refer here to learn more.

Note

Coding Activity: Total hours coded over the last 7 days from Yesterday, using default 15 minute timeout, only shows coding activity from known languages.

Public Leaderboards: You will appear in the public leaderboards only if your weekly coded hours is around 10 hrs(Changes from time to time).

---

Example

Wakatime Leaderboards (Worldwide)

Public Leaderboards (Weekly)

Ranked	Hours Coded	Daily Avg
None	10 hrs 19 mins	1 hr 28 mins

Top Language (JavaScript)

Ranked	Hours Coded	Daily Avg
None	4 hrs 4 mins	34 mins

---

Update README

Add below comment in your markdown file for Wakatime Leaderboards Stats

<!-- Wakatime-Start -->
<!-- Wakatime-End -->

---

Setup with Example

After completing the steps mentioned in the Prerequisites, you have to save all the mentioned keys(except markdown comments) like Wakatime API Key as Secrets in your Github repo's settings.

Repo Settings -> Security -> Secrets and Variables -> Actions -> Add in Repository Secrets

If you are new to Github Secrets then you can checkout this official doc here.

Sample Workflow File

wakatime.yml

name: Wakatime Leaderboards

on:
    schedule:
        # Runs every Monday at 12AM IST (UTC+5:30)
        - cron: "30 18 * * 0"
    workflow_dispatch:
    push:
        branches: master

jobs:
    update-readme:
        name: Wakatime Leaderboards
        runs-on: ubuntu-latest
        steps:
          - name: Run Wakatime Leaderboards
            uses: nicconike/wakatime-leaderboards@master
            with:
                WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}

---

Contributions

Star⭐ and Fork🍴 the Repo to start with your feature request(or bug) and experiment with the project to implement whatever Idea you might have and sent the Pull Request through 🤙

Please refer Contributing.md to get to know how to contribute to this project. And thank you for considering to contribute.

---