Installation

Installation

AXIS ships as the axis package (Solid + Vite), version 2.5.0. Primary path is the product UI under src/. Legacy static shell (main.js, root style.css) is not the product UI—prefer bun run dev or built dist/.

Abstract

Operator modes:

Backend is optional when Engine = Client-Side (Pyodide) and sources/streams are mock or CSV.

Prerequisites

• Bun ≥ 1.2 for package install, Vite, and the AXIS CLI
• Python 3.10+ if you use Flask Pro API (make run) or axis_pwa_server.py
• Modern Chromium / Firefox / Safari (PWA install works best on Chromium)
• Optional: Cloudflare® auth (CLOUDFLARE_API_TOKEN or wrangler login) for Worker deploy
• Optional desktop: Rust + platform webview libs — Desktop (Tauri)

CLI-first bootstrap (recommended)

# From the AXIS monorepo root
bun install
cd packages/cli && bun install && cd ../..

axis install          # app + worker/ + CLI deps
axis doctor           # toolchain + optional CF auth; wrangler.toml warns until `axis setup`
axis setup            # ensure wrangler.toml + local D1 schema
# repo aliases (no global install): bun run axis:install / axis:doctor / axis:setup
# or: make axis-install && make axis-doctor && make axis-setup

Full command surface: AXIS CLI.

Dev AXIS

# Terminal 1 — Pro API (server engine) from sister pyne repo
# Clone https://github.com/hoox-sh/pyne as ../pyne (local dir is sometimes still named pynescript)
make -C ../pyne run          # Flask :5002

# Terminal 2 — AXIS
bun run dev                  # Vite :3000
# or: bun run axis dev

Open http://localhost:3000. Default symbol BTCUSDT, engine often server with endpoint http://localhost:5002 (or demo host https://axis.hoox.sh).

Desktop shell (optional)

bun run desktop:dev          # Tauri window + Vite HMR
bun run desktop:build        # native installers

See Desktop (Tauri).

Edge Worker (local)

bun run axis dev worker      # wrangler :8787
# or: cd worker && bun run dev

In AXIS: open Workers Manager (topbar activity icon) or Settings → set Backend URL to http://127.0.0.1:8787. Production Worker is worker-axis at https://worker.axis.hoox.sh — see topologies.

Deploy checklist (prod)

axis setup --github-client-id Ov23li… --remote-d1
axis secret put ADMIN_TOKEN
axis secret put EXTERNAL_BACKEND
axis deploy
axis health --oauth

Production build (static)

axis install
bun run build                # → dist/
python3 axis_pwa_server.py   # serves dist/ on :8081

Confirm:

• App shell loads; chart requests history
• DevTools → Application → Manifest + Service Worker
• Icons 192/512 from public/assets/

Pyodide assets and vendor wheels under public/pyodide/ and public/vendor/ must be present in dist/ for offline engine—bun run build copies them via Vite public/.

Offline-first lab (no Flask)

1. Source → Mock Walk
2. Stream → Mock Poll (or None)
3. Engine → Client-Side (Pyodide)
4. Storage → Local

Disable network in DevTools; Run still executes. First Pyodide boot downloads/loads self-hosted runtime from the origin—allow that once while online, then go offline.

CORS when using server engine

Browser origin → Pro API must allow your AXIS origin. Flask uses ALLOWED_ORIGINS. Localhost regex is typically included; for a VPS demo host, set an explicit origin list. Symptom of failure: POST /run blocked in Network tab (no Access-Control-Allow-Origin). Worker CORS: CORS and origins.

PWA install

• Manifest: void theme #0a0b10, name AXIS
• Service Worker: cache-first shell; network-first /api/*; offline API returns structured failure so Pyodide path remains usable
• Chrome/Edge: install icon in the omnibox; AXIS also shows a modest Install app chip in the topbar when the browser fires beforeinstallprompt (right-click hides it for the session)

Verification checklist

Failure modes

Internals (repo paths)

See also

• Quick start
• Compose recipes
• AXIS CLI
• DevOps local dev
• Desktop (Tauri)
• Worker