Skip to content

deployment.md

Latest commit

 

History

History
59 lines (39 loc) · 1.18 KB

deployment.md

File metadata and controls

59 lines (39 loc) · 1.18 KB
Raw

Deployment

Deployment support is intentionally local-first and deterministic. The default path is Docker for repeatable builds and local service startup.

Included assets

  • Dockerfile
  • docker-compose.yml
  • .github/workflows/ci.yml

Docker commands

Build the default image:

docker build -t apex-trading-engine .

Validate the compose model:

docker compose config

Run the deterministic demo container:

docker compose run --rm app

Start the artifact API:

docker compose up api

Start the dashboard:

docker compose up dashboard

Service behavior

  • app runs the synthetic demo and exits after it writes artifacts.
  • api serves local run artifacts from artifacts/runs.
  • dashboard serves the read-only Streamlit UI.

Environment notes

  • APEX_ARTIFACT_ROOT overrides the API artifact root.
  • STREAMLIT_SERVER_HEADLESS=true keeps the dashboard container non-interactive.
  • No deployment path requires secrets for the default demo.

Limitations

  • No service requires broker credentials.
  • No service requires paid market data.
  • Docker images are for deterministic local execution, not production trading.