Repository navigation
Quick Start
Use Supabase Deployment for the current system. Keep the PC on, awake, and signed in; connect phone Tailscale and open the same private PC HTTPS origin. The laptop can be off and TiDB is not required. Verify the current approved release/session and runtime readiness before trading. The steps below describe a safe fresh development start, not resetting an already armed executor.
-
Use Python 3.11 or 3.12 on Windows.
-
From the repository root, install the tested dependency graph:
python -m pip install --require-hashes -r requirements.lock python -m pip check
-
Copy no secrets into source files. Put optional MySQL and KIS values in the gitignored
.env; use.env.exampleas the schema. -
Start the desktop app:
python main.py
-
Run the complete offline test suite before changing trading code:
pytest -q
The app can open without MySQL or KIS. Database-backed scanning, cache freshness, account data, and broker operations will remain unavailable or read-only as appropriate.
- Confirm the toolbar Live Trading control is off.
- The Buy Board runtime may be available, but confirm
KIS_LIVE_EXECUTION_MODE=DISABLED, Live Trading is locked/off, and broker mutations remain blocked unless you are following the controlled-live runbook. - Open Health and review MySQL, KIS age, mirror freshness, reconciliation, journal health, and free-space checks.
- Use Scanner, Watchlist, Buylist, and charts before configuring execution.
- Never use real credentials to run tests.
See Configuration before enabling optional services. Before operating Buy Today or Entry Pending, read Current Order Logic.
For the optional connected phone/PWA, use the authenticated web launcher and explicit operation allowlists. Routine actions synchronize automatically; a manual desktop or browser refresh is not an execution requirement. Read Web/PWA Operator Synchronization before enabling connected writes.
- Home
- Supabase Deployment
- Project Tour
- Quick Start
- System Overview
- Architecture
- Installation and Environment Setup
- Configuration
- User Workflow
- Watchlist and Buy List
- Buy Board and Kanban States
- Scanner and Charts
- Market Data and Database
- Synchronization
- Web/PWA Operator Synchronization
- KIS API Integration
- Current Order Logic
- Order Lifecycle
- Risk and Safety Controls
- Background Jobs and Automation
- Testing
- Operations and Monitoring
- Troubleshooting
- Security
- Glossary