Skip to content

Toolchain Overview

The srk ecosystem provides a suite of tools around the data format specification, covering the complete workflow from data production to display and distribution.

Ecosystem Projects

ProjectPurposePackage
Standard RanklistSpec definition, types, and Schema@algoux/standard-ranklist
Renderer ComponentWeb rendering componentsRenderer Component
CLIOperate srk files with command-line workflows@algoux/standard-ranklist-cli
UtilsUtility library for JavaScript/TypeScript, Python, and GoUtils Library
Convert-toFormat conversion tool@algoux/standard-ranklist-convert-to

Typical Workflow Examples

Scenario 1: Displaying a Ranklist in Your Application

srk → Renderer Component → Your Application
  1. Prepare srk data or implement an API that outputs srk
  2. Use the Renderer Component in your web application
  3. Pass srk data to the component for rendering

Scenario 2: Exporting to Other Platform Formats

srk → CLI convert / Convert-to → Codeforces Gym / Excel / VJ Replay
  1. Prepare srk data
  2. Use srk convert or the Convert-to tool to select the target format
  3. Generate the target format file

Scenario 3: Maintaining and Publishing srk Files

srk → CLI validate / diagnose / convert / preview / render → CI / Static Pages / Exported Files
  1. Use the CLI to validate srk file structure and find common data issues
  2. Export Excel, VJudge Replay, or Codeforces Gym Ghost files when needed
  3. Preview ranklists locally in the browser
  4. Render static pages for archives, publishing, or PR review