Skip to content

Project Documentation

This directory is the main documentation root for quant-app.

Start here:

Suggested reading order for a new contributor:

  1. Architecture Overview — system map and module boundaries
  2. Live Market Pipeline And Processor Machinery — the core runtime path
  3. Backend Conventions — DI patterns, bridge contracts, module manifests
  4. Testing Guide — how behavior is verified
  5. Roadmap — current milestone status and what to work on next

Project-Wide Docs

Document Covers
Architecture Overview System topology, module boundaries, bridge contracts, deployment model, design goals
Live Market Pipeline And Processor Machinery Live feed, processor, strategy execution, trade execution, recorder, server publishing
Backend Conventions DI patterns, data-bridge boundary, module Kubernetes manifests and test suites for database/recorder/sync
Testing Guide Test layering, processor-path coverage, helper layout, current gaps
Build System Build types, Gradle plugins, JKube extension, image convention, key properties
Infrastructure Terraform edge, OCI/Cloudflare production and local dev stacks, deployment environments
CI/CD GitHub Actions pipeline, TeamCity pipeline structure and validation
Frontend Web distribution model, Compose dependency versioning, ViewModel conventions
Roadmap Milestone ladder toward live trading, current status, blockers
GitHub Issue Workflow ISSUES.md scratch-pad format, sync-markdown CLI, issue CRUD

Module-Local Docs

These remain the right place for subsystem-specific notes that would become noisy in the project-wide docs:

  • terraform/edge/oci/README.md: OCI production edge stack and Cloudflare tunnel setup
  • terraform/edge/local/README.md: local dev edge stack and Cloudflare tunnel setup
  • frontend-charts/README.md: general charting module usage
  • frontend-charts/TRADING_CHARTS.md: trading-chart-specific usage and data mapping

Treat docs/ as the index for those module-local notes even when the source file stays next to the code.

Documentation Conventions

  • Prefer docs/ for project-wide and cross-module documentation.
  • Prefer module-local docs for notes that only matter to one module.
  • If an older root-level note overlaps with a document in docs/, treat the file under docs/ as the source of truth.