annikastein / wca-german-state-ranks

🏆 Displaying the PRs of people who have given explicit consent to appear in German WCA state rankings. Federal state data taken from the GCA Discord Server (reaction roles), PRs taken from the WCA database via the unofficial API.

WCA German State Ranks

Displaying the PRs of people who have given explicit consent (opt-in) to appear in German WCA state rankings. Federal state data taken from the GCA Discord Server (reaction roles), PRs taken from the WCA database via the unofficial API.

How to appear in these rankings?

• Join the GCA Discord Server and read + understand the rules.
• Append your WCA ID to your username (example: Nickname | 2024ABCD42)
• Click one of the 16 federal state reaction roles.

Data statement

This information is based on competition results owned and maintained by the World Cube Assocation, published at https://worldcubeassociation.org/results as of April 20, 2024.

wca-german-state-ranks's Issues

Automate the boring stuff

... really, this is an ideal task for a GH workflow, it screams! A wf to run on schedule (maybe not daily, while the API is updated that frequently, the roles are not).
Not so sure about the integration with discord, not everyone puts their existing WCA ID into the username for the server with the correct pattern, or at all.

Documentation / more info for README

• Comments in py-scripts
• API links / sources in README
• Instructions to join the rankings
• Correct version date (also from API, write with script)

Backend / scripts to interact with API and create views

• Take GCA Discord info, store in repo
• Select wca ids and write out ranks
• Sort by rank, name in respective state dictionary
• Build output html
• check for country (as some entries selected a state, with country not equal to DE) and for that, sort by rank
• pick the current country actually, not a former one - if the API permits, see robiningelbrecht/wca-rest-api#9
• link to WCA profile via WCA ID
• proper handling of the "value" -> a time, a number, or sth else, decode according to https://www.worldcubeassociation.org/export/results (done for every speed event, not yet for fm, mbf)
• ties within a federal state

Frontend / UI to view the ranks

• basics
• buttons
• style, depending on viewport etc., mobile
• non-de style
• customization per state
• exclude / include old events (i.e. only the current 17 or more)
• exclude / include nonDE in state ranks
• merge tables for overview
• exclude / include nonDE in overview
• link to WCA profile via WCA ID
• stripe tables bg / gray alternating
• single / average switch