Skip to content

sppidy/janus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Janus

License: Apache 2.0 CI

Open-source paper-trading platform spanning Indian equities (NSE) and Forex, with a shared HTTP + WebSocket contract powering web, desktop, and Android clients.

This is a meta-repo: every component is its own git submodule with its own license, CI, and issue tracker.

⚠️ Disclaimer: Paper-trading only — no live order code is wired. Not financial advice. Trading involves risk.

Layout

Path Repo Stack Role
nse-agent/ sppidy/janus-nse-agent Python, CatBoost NSE trading agent (rule-based + LLM + ML)
nse-backend/ sppidy/janus-nse-backend FastAPI, uvicorn Single-user backend wrapping nse-agent
web/ sppidy/janus-web Vanilla JS Dashboard served by nse-backend at /dashboard
windows/ sppidy/janus-desktop WinUI 3 / .NET 8 Desktop client
android/ sppidy/janus-android Kotlin / Jetpack Compose Mobile client
forex-agent/ sppidy/janus-forex-agent Python Forex agent (ICT-style strategies)
forex-backend/ sppidy/janus-forex-backend FastAPI + PostgreSQL + Docker Multi-user forex backend

Architecture

Web dashboard ─┐
Desktop app ───┤     ┌── NSE backend (single-user, in-memory jobs)
Android app  ──┼────►│      └── dynamically imports nse-agent modules
               │     │
               └────►└── Forex backend (multi-user, PostgreSQL, Docker)
                              └── imports forex-agent modules

All three clients speak the same HTTP + WebSocket contract. Each stores per-profile base URL + API key, so one client binary flips between NSE main, NSE eval, and Forex backends without rebuild.

Full architectural reference: AGENTS.md.

Getting started

git clone --recurse-submodules https://github.com/sppidy/janus.git
cd janus

Full setup is in QUICKSTART.md — one-page guide covering the NSE path, the Forex path, client builds, and the production hardening checklist.

Documentation

  • QUICKSTART.md — get a stack running in ~5 minutes (NSE path + Forex path + production hardening checklist)
  • AGENTS.md — full architectural reference (every submodule, every endpoint, every CI workflow, every security knob)
  • docs/GROWW_SDK.md — Groww REST + MCP reference, rate limits
  • docs/HDFC_SKY_API.md — HDFC Sky API endpoint notes (offline mirror of the dev portal)
  • docs/DEPLOY_SECURITY_NOTES.md — server hardening checklist for the FastAPI backends

CI / build

Workflows live in .github/workflows/:

File What it builds
ci.yml pytest for nse-agent + nse-backend; compileall smoke for forex agent/backend; gradle unit tests for android/; asset-presence check for web/
android-build.yml Debug + signed release APK from android/ (uses RELEASE_* GH secrets)
desktop-build.yml msbuild Release x64 of the WinUI solution under windows/

Contributing

PRs welcome. Read CONTRIBUTING.md first — short version: open an issue first for non-trivial changes, target the relevant submodule, sign your commits, and don't add Co-Authored-By AI trailers.

Security

Don't open public issues for security problems. See SECURITY.md.

License

Apache-2.0 — use, modify, fork, or sell freely; just keep the copyright notice + NOTICE, and (per Apache §4b) flag changed files. Includes an explicit patent grant. No financial advice; trading involves risk.

About

Janus — open-source paper-trading meta-repo: NSE + Forex agents, web/desktop/Android clients

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages