kcfgc-sync

A collection of utilites for pulling data out of start.gg and syncing it elsewhere.

Setup

In the root of the repo:

npm i -g pnpm
pnpm i

Development

Run to build everything in watch mode during development:

npm run watch

CI/CD

To add a hub whose tournaments will automatically be discovered and synced to the website, add its slug to auto-hubs.txt. To add a one-off tournament to be synced, add its slug to auto-tournaments.txt.

Packages

common

Contains the shared schema describing a tournament.

start-gg

All commands take an api-key argument (can be omitted if the START_GG_API_KEY env variable is set).

tournaments

Utility for extracting tournament information from start.gg. Takes a list of arguments that are the tournament slugs to extract. Writes to stdout.

node packages/start-gg/dist/index.js tournaments --api-key=mystartggapikey combo-breaker evo myothertournament

hubs

Utility for extracting hub information from start.gg. Takes a list of arguments that are the hub slugs to extract. Writes to stdout.

node packages/start-gg/dist/index.js hubs --api-key=mystartggapikey magic-pixel myotherhub