shields icon indicating copy to clipboard operation
shields copied to clipboard

Badge request: WhatPulse

Open jerone opened this issue 3 years ago • 0 comments

:clipboard: Description

WhatPulse is a small application that measures your keyboard/mouse usage, down- & uploads and your uptime.

The software tracks a user's pressed keys, mouse clicks and used bandwidth and the uptime of the system. Users can see where they are in a leaderboard of people who have joined the program and compare themselves against people from their own countries. Users can also join teams, which enables them to compare themselves against people with similar interests.

Example user profile: https://whatpulse.org/jerone

It would be great to have badges for those data-points and ranks.

:link: Data

Web data is available here: https://help.whatpulse.org/api/web-api The API is publicly available and doesn't need any (authorization) tokens or keys.

As seen in the example, data is available for every data-points & ranks:

  • Keys
  • Clicks
  • Download
  • Upload
  • UptimeShort (UptimeLong & UptimeSeconds are probably not interesting/useful)
  • Ranks:
    • Keys
    • Clicks
    • Download
    • Upload
    • Uptime

There is also data & ranks available for teams. That would be a good second feature.

Besides choosing one of the above keys, an username is required.

Example badges using real data from my account (images are clickable to see the dynamic url):

Data key Stats Rank
Keys

WhatPulse Keys

WhatPulse Keys

Clicks

WhatPulse Clicks

WhatPulse Clicks

Download

WhatPulse Download

WhatPulse Download

Upload

WhatPulse Upload

WhatPulse Upload

Uptime

WhatPulse Uptime

WhatPulse Uptime

~~Colors are debatable. No opinion here. WhatPulse doesn't really have an distinct brand color.~~ The author of WhatPulse suggest using one of the following colors: #374856 and #2C5B75

:microphone: Motivation

WhatPulse keeps records of all your data and compares that against other users and teams. It would be nice to show your own stats and ranks.

I would use this in my GitHub Readme and in forum signatures.

The example badges in the table above are created with the dynamic api from shield.io. This works great for the stats-badges. But for the rank-badges it is missing an dynamic suffix. Right now it's hardcoded "th" behind the value, for demo purposes. An custom implementation here would be needed to calculate the correct suffix based on the value.

jerone avatar Sep 01 '22 14:09 jerone