Quickstart

Follow these steps to initialize the Zoris Engine and connect to the market telemetry and intelligence pipeline.

1. Provisioning

Clone the repository and prepare your Python 3.12+ virtual environment:

git clone https://github.com/Javannio/zoris-engine.git
cd zoris-engine
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt

If your deployment platform fails at the clone step with a GitHub 500 error, verify the repository is reachable from the deployment environment and that any required access token or GitHub App install is valid. For private repositories, prefer an authenticated clone URL supported by your platform or make sure the deploy key/token has read access to Javannio/zoris-engine.

If the repository is public and the error persists, retry the deployment after checking GitHub status and the platform's source-repository integration settings.

2. Configure Environment

Create a .env file in the project root with your API key configuration. This file is gitignored and must never be committed:

ZORIS_MASTER_KEY=<your-master-key>
AUTO_TRIAL_TIER=STANDARD

3. Launch the Compute Core

Boot the FastAPI service using Uvicorn:

uvicorn zoris_api:app --host $HOST --port $PORT --reload

4. Launch the Frontend

cd frontend
npm install
npm run dev

5. Verify Telemetry

Ping the health endpoint to confirm the engine is responsive:

curl http://localhost:$PORT/api/market/latest -H "X-API-Key: $YOUR_API_KEY"

6. Schedule the Pipeline

Set up cron jobs for automated operation:

• Telemetry scrapers: Run at market close on the upstream node
• Compute pipeline: Run immediately after telemetry data arrives
• Morning Intel: Run before market open for pre-market suggestions
• Macro aggregation: Run weekly on Mondays