Skip to main content

Getting Started with TraderX

TraderX has multiple generated codebases representing different learning states, from a simple pre-container baseline to a more feature-rich platform with pricing, order management, and platform tooling.

Where To Find The Code​

If you want to run demos quickly, use the generated state branches listed below.

Generated Codebase States​

The YU states are this fork's own line and their generated branches live HERE, not upstream; the links above point at finos/traderX because those states are upstream's. Same branch naming, different repository, and conflating the two sends a reader to a 404 on someone else's project.

Why This Works​

These codebases are generated from specifications using GitHub Spec Kit.
Specs, templates, and generation logic are the maintained source of truth; generated code branches are the runnable outputs.

Contribution Workflow​

If you want to contribute new states:

  1. Clone the main TraderX repository on macOS or Linux.
  2. Use your preferred agentic coding assistant (for example Amp, Claude Code, or Codex).
  3. Choose the parent state from the Learning Paths.
  4. Define the new state in specs (requirements, plan, tasks, architecture, contracts, and generator changes).
  5. Implement and validate in the spec/source branch.
  6. Commit spec/docs/generator changes, then publish the generated state branch.

Example contribution themes:

  • Service mesh adoption.
  • Multi-temporal data support and related UI updates.
  • Swapping messaging or database implementations.

Corporate Internal Extension Point​

If your organization needs private runtime constraints, internal-only states, or private generated branches:

  1. Start with the canonical overlay starter under examples/custom-overlay-template/.
  2. Create a separate corporate overlay repository (do not fork TraderX for corporate-only deltas).
  3. Add TraderX as a pinned submodule dependency.
  4. Tailor the included profile, transform, and internal-docs examples to your environment policy.
  5. Publish an internal docs portal that includes only your sanctioned internal learning graph branches.

Local EOD bundle state: YU18-risk-integration (parent YU17-otc-rates). Its configured generated branch is code/generated-state-YU18-risk-integration; this local implementation has not been published. Run its source quickstart under specs/YU18-risk-integration/quickstart.md.