QuanuX is an early-stage, open-source quantitative research and trading platform.
This repository represents a pre-release development snapshot as the project approaches its first public technical milestone: v0.0.1-pre.
QuanuX is currently in active development and should be considered experimental.
- APIs, schemas, tools, and internal architecture may change
- Features may be incomplete or non-functional
- Documentation is evolving
- Backward compatibility is not guaranteed
This repository is being made public to support early testing, architectural review, experimentation, and visibility as the project approaches its initial release.
It is not yet a production-ready system.
Current development target: v0.0.1-pre
Semantic versioning will be introduced once public APIs stabilize.
- Python 3.10+ (Required for the server)
- Node.js v20+ & pnpm (Required for the client)
- Enable pnpm via:
corepack enable
- Enable pnpm via:
- Rust & Cargo (Required for development and building the Tauri desktop app)
Clone the repository and set up the environment:
# Clone the repository
git clone https://github.com/quantdiy/QuanuX.git
cd QuanuX
# Set up Python Virtual Environment
python3 -m venv .venv
source .venv/bin/activate # Windows: .venv\Scripts\activate
# Install Dependencies
# This installs Python dependencies for the server
pip install -r requirements.txt
# This installs Node dependencies for ALL client packages and server bridges
pnpm installQuanuX uses the OS Keyring to securely store API keys.
Note for Linux Users: You may need to install system headers for the keyring backend (e.g.,
libsecret-1-dev,dbus-x11, orgnome-keyring). macOS and Windows use native system stores.
Option A: Interactive Setup (Recommended)
python -m server.cli.setup_secretsThis utility prompts for:
TOPSTEP__USERNAME,TOPSTEP__PASSWORD, &TOPSTEP__API_KEYOPENAI_API_KEYQUANUX_GEMINI_API_KEYTRADINGVIEW_CLIENT_ID
Option B: Manual / Additional Keys
You can also add keys via the Integrations page in the app, or manually using Python (e.g., for Gemini):
# Example for Gemini
# Note: Ensure the key name matches what the application expects (e.g. QUANUX_GEMINI_API_KEY)
python -c "import keyring; keyring.set_password('QuanuX', 'QUANUX_GEMINI_API_KEY', 'your_api_key')"Option C: Import from .env
# Create .env file with your keys (e.g. QUANUX_TOPSTEP__API_KEY=...)
python -m server.cli.import_envYou will need two terminal sessions.
Terminal 1: Start the Server
# Ensure venv is active
source .venv/bin/activate
uvicorn server.app.main:app --host 0.0.0.0 --port 8080 --reloadTerminal 2: Launch Desktop App
pnpm -C client/desktop/tauri-app tauri devIf you want to create a standalone executable (e.g., .dmg, .exe, or .app) rather than running in development mode:
pnpm -C client/desktop/tauri-app tauri buildThis will output the installers/bundles to client/desktop/tauri-app/src-tauri/target/release/bundle.
QuanuX is licensed under the GNU Affero General Public License v3.0 (AGPLv3).
- You may use, modify, and distribute this software under the terms of the AGPL
- If you run a modified version as a network service, you must make the source available
If you wish to use QuanuX in a way that is not permitted under the AGPLv3 —for example, offering it as a closed-source or proprietary service— please contact the project owner to discuss commercial licensing options.
See the LICENSE file for full details.
At this stage:
- The project is not yet accepting formal external contributions
- Interfaces and internal boundaries are still settling
- Contribution guidelines will be added once
v0.0.1stabilizes
Public visibility is intended to support review and exploration, not yet coordinated development.
This software is provided as-is, without warranty of any kind.
Nothing in this repository constitutes financial advice, trading advice, or investment recommendations.
QuanuX is approaching its first stable technical checkpoint.
Further documentation, examples, and contribution guidelines will follow as the project matures beyond the v0.0.1 pre-release stage.