@open-competition-kit/sdk
v0.0.6
Published
Readme
@open-competition-kit/sdk
@open-competition-kit/sdk is the application-facing API for Open Competition Kit. It initializes the core services, exposes promise-based helpers for competitions, tracks, users, enrolments, submissions, jobs, forms, leaderboards, context, outputs, and secrets, and re-exports the core types package authors need.
Open Competition Kit is a modular toolkit for running programming competitions. A competition is described in competition.config.yaml, then extended with packages that provide storage, submission forms, enrolment behavior, runners, integrations, and leaderboards.
Most projects use the SDK from TypeScript code rather than adding it to a with section. Package authors import Package, makeComponent, kit, or specific helpers from the SDK:
import { kit, submissions, type Package } from "@open-competition-kit/sdk";Runtime behavior still comes from packages listed in competition.config.yaml:
with:
- "@open-competition-kit/standard"For contributors, set up the repository from the monorepo root:
git clone https://github.com/open-competition-kit/open-competition-kit.git
cd open-competition-kit
bun install