# FlintTrade

Version: v0.0.1

Open-source self-hosted trading software built with Python, React, TypeScript, and Rust.

## Core docs
- [FlintTrade Documentation](/docs/): Welcome to the FlintTrade documentation. FlintTrade is a beta-stage trading workspace with evidence-gated native broker contracts and a local Practice sandbox.
- [FlintTrade Feature Inventory](/docs/inventory): This is the build-status inventory the project's roadmap calls for: every mission pillar and feature, categorised as (a) built & working, (b) built but untested or only partially w
- [FlintTrade Disclaimer](/docs/disclaimer): FlintTrade v0.0.1 is a beta-stage open-source project. It is not production ready, not a registered investment advisory product, and not a managed trading service.
- [FlintTrade Desktop](/docs/desktop): FlintTrade is a self-hosted web app first. The backend serves the terminal and API from one origin, and a normal browser remains the primary supported way to run it. The desktop pa
- [FlintTrade User Guide](/docs/user-guide): This guide walks you from a fresh install to local setup, sandbox workflows, and Live-mode safeguard verification. The default reading order is top-to-bottom — every section builds
- [FlintTrade Developer Guide](/docs/developer-guide): Broker connections use six native adapters: Dhan, Upstox, Kotak Neo, INDmoney, Groww, and Delta Exchange. Availability remains evidence-gated. Native broker HTTP mutations and read
- [FlintTrade Architecture](/docs/architecture): Broker connections use six native adapters: Dhan, Upstox, Kotak Neo, INDmoney, Groww, and Delta Exchange. Availability remains evidence-gated. Native broker HTTP mutations and read
- [Technology Stack and Dependencies](/docs/tech-stack): FlintTrade combines a React trading terminal, a Python backend, a Rust tick engine, an Electron desktop shell, and a Next.js documentation site. This guide explains what the main d
- [FlintTrade API Reference](/docs/api): FlintTrade owns the terminal’s authenticated HTTP transport. Native broker reads and account mutations remain frozen; Practice uses the local sandbox.
- [FlintTrade — Supported Versions](/docs/compatibility): What FlintTrade is known to work with at runtime. These projects are > NOT bundled with FlintTrade — you install them separately. This page > tells you which versions are safe to i
- [Order Safety Notes](/docs/order-safety): FlintTrade is personal-use, self-hosted software. It is not a broker, an investment adviser, a managed strategy product, a compliance product, or a service that accepts funds or ac
- [Checks and continuous integration](/docs/ci): Use the affected gate while editing and the exhaustive gate before pushing. Both use the cross-platform task runner:
- [References and Credits](/docs/references): FlintTrade is an original AGPL-3.0 project, but it is built in the open and learns from existing open-source trading, charting, UI, and agent projects. This page is the public attr
- [Machine Setup Guide](/docs/setup/quickstart): Works on any Windows, macOS, or Ubuntu machine — including a new contributor's box. > FlintTrade v0.0.1 is not production ready; use Practice, and example data, > before connecting
- [FlintTrade on macOS](/docs/setup/macos): FlintTrade v0.0.1 is not production ready; use Practice and example data > before connecting any live broker workflow.
- [FlintTrade on Linux (Ubuntu/Debian)](/docs/setup/linux): ## One-line install (recommended — no prerequisites)
- [FlintTrade on Windows](/docs/setup/windows): FlintTrade v0.0.1 is not production ready; use Practice and example data > before connecting any live broker workflow.
- [FlintTrade on Raspberry Pi](/docs/setup/raspberry-pi): Raspberry Pi is an advanced server-style deployment target. For ordinary use on Linux, macOS, or Windows, prefer the one-line web install:
- [Static IP Setup](/docs/setup/static-ip-setup): Many Indian broker APIs require an allow-listed static public IP before live orders are accepted. FlintTrade does not apply for this on your behalf; you do it directly in your brok
- [Email Setup](/docs/setup/email): Email is used only for account recovery and OTP flows when those features are enabled. A local-only single-user install can run without SMTP, but password reset email will not work
- [Backup and Restore](/docs/setup/backup): Ordinary backups are bhavcopy CSV archives, not full workspace or credential snapshots.
- [Multi-User Mode — removed (out of scope)](/docs/setup/multi-user): FlintTrade is a personal-use, single-operator trading workstation: the operator is the user is the data principal. The multi-user CRUD scaffold (/api/v1/users/, an admin/trader/vie
- [FlintTrade v0.0.1](/docs/releases/v0.0.1): FlintTrade v0.0.1 is a pre-release. It is not production ready; use Practice, and example data, before connecting any live broker workflow.
- [Docs and Contribution MCP](/docs/mcp): Read-only MCP surfaces for development, documentation, and contribution workflows.
- [Contributing Through the Site](/docs/contributing): How the public site guides developers from reading docs to opening focused pull requests.

## Packages
- apps/desktop: Part of FlintTrade — the Electron 44 shell for the self-hosted terminal. (packages/apps/desktop/README.md)
- apps/site: Next.js + Fumadocs public website, generated documentation, contribution pages, llms files, and read-only docs MCP. (packages/apps/site/README.md)
- apps/terminal: Single-page terminal — FlexLayout workspace with home widgets, tools, routes, and workspace presets. (packages/apps/terminal/README.md)
- core/core: Flask backend, authentication and workspace management with a frozen native broker read facade. Native broker HTTP reads remain unavailable. (packages/core/core/README.md)
- core/data: Tick recorder, append-only hash-chained audit logger, trade logger, DuckDB storage, and a (dormant) QuestDB writer. (packages/core/data/README.md)
- core/design-system: Shared FlintTrade design tokens, brand primitives, layer scale, motion contracts, and React UI components. (packages/core/design-system/README.md)
- core/historical: Synchronous OHLCV helpers, local DuckDB storage and independent OpenChart/yfinance downloads. Native broker history remains unavailable under the read freeze. (packages/core/historical/README.md)
- core/indicators: 110 exported indicator functions and streaming classes — pure-NumPy batch indicators, pure-Python streaming variants (optional Numba acceleration on 3 batch kernels), and Pine Scri (packages/core/indicators/README.md)
- core/ticks: High-performance tick-processing engine — Rust core with Python bindings. (packages/core/ticks/README.md)
- integrations/gateway: Native gateway with six broker adapters, a safety-gated router, encrypted credentials and local tick dispatch. Native broker HTTP and network capture remain unavailable. (packages/integrations/gateway/README.md)
- integrations/webhooks: HMAC-validated custom webhook intake rail for generic inbound alerts. (packages/integrations/webhooks/README.md)
- services/ai: Local LLM client, RAG pipeline, multi-agent trading team, ML signal generation, and skill swarm. (packages/services/ai/README.md)
- services/automation: Cron scheduler, Telegram bot with kill switch, post-market analysis pipelines. (packages/services/automation/README.md)
- services/backtest: Strategy simulator, walk-forward and Monte Carlo testing, portfolio backtester, and 94 strategy template modules across 6 categories. (packages/services/backtest/README.md)
- services/ditto: Native account metadata, analytics and position/stop monitors (AlgoMirror patterns absorbed in-process). Broker execution remains unavailable under the native runtime freeze. (packages/services/ditto/README.md)
- services/engine: Five-layer order-admission safety, gated scheduled-strategy execution, scheduler, base strategy class, AST-guarded sandbox executor, bracket-order engine, mode guard, and reconcili (packages/services/engine/README.md)
- services/journal: Trade journal service for entries, trade logging, execution-quality analytics, and realised P&L tracking. (packages/services/journal/README.md)
- services/screener: Option chain, OI analysis, PCR, max-pain, futures quadrant, portfolio Greeks, IV smile, fundamental screener, FII / DII tracker, and RRG calculator. (packages/services/screener/README.md)

## MCP scope
The public MCP surface is read-only and limited to documentation, package orientation, test recommendations, and contribution planning.