Skip to content

Latest commit

 

History

History
149 lines (104 loc) · 5.07 KB

readme.md

File metadata and controls

149 lines (104 loc) · 5.07 KB
Raw

Project Overview

This repository is a monorepo containing three main projects:

  1. steadfast-app: The frontend application.
  2. steadfast-api: The backend API server.
  3. steadfast-websocket: The WebSocket service.

Quick Status (Updated: 10-09-2024)

Legend: 🟢 Available/Implemented 🟡 In Progress 🔵 Planned ⚡ Requested by our users 🔴 Not Currently Considered

Feature Status
Supported Brokers
Flattrade 🟢
Shoonya (Finvasia) 🟢
⚡ Other Brokers 🔴
Trading Operations
Place Buy/Sell at market/limit orders 🟢
Cancel orders 🟢
Cancel selected orders 🔵
Close all positions 🟢
Close selected positions 🟢
Select strikes 🟢
Modify open/pending order 🔵
Basic Features
Automatic ATM strike selection 🟢
Selection Offsets 🟢
Live MTM / PNL by Amount & ROI Percentage 🟢
Target & Stoploss by Percentage/Amount 🟢
Trailing Stoploss 🔴
⚡Underlying & Futures based Target & Stoploss 🔵
Basket Orders 🟢
Ready Made Strategies 🟡
Key Features
One-click trading buttons 🟢
Kill switch (client-side) 🟢
Overtrade Protection 🟢
Trade Journal 🔵
Paper Trading 🟡
Reports For IT Filing 🔵
Real-Time Market Data
LTP for underlying 🟢
LTP for selected call/put strikes 🟢
LTP Range Bar 🟢

Note:

  • kill switch works on client side only, you will still be able to trade from your broker terminal.
  • All these symbols can be traded: NIFTY, BANKNIFTY, FINIFTY, MIDCPNIFTY, SENSEX, and BANKEX.

App Screenshots

Light Mode

Preview in Light Mode

Dark Mode

Preview in Dark Mode

App Settings

Preview in App Settings

LTP Range Bar

Preview in LTP Range Bar

One Click Trading Keys

Preview in One Click Trading

Add Broker

Preview in Add Broker

Manage Brokers

Preview in Manage Brokers

Join Our Telegram Channel

Stay updated by joining our Telegram Channel.

Steps to run the app

Step 0: Prerequisites

Operating System: Windows 11

  1. Ensure Git is installed and accessible from the command line.
git --version
  1. Ensure Node.js v21.7.3 and npm v10.5.0 are installed and accessible from the command line.
node -v && npm -v
  1. Ensure Python 3.12 is installed and accessible from the command line.
python -V

Step 1: Clone the Steadfast Monorepo

  1. Open your terminal or command prompt.
  2. Run the following command:
git clone https://github.com/narenkram/steadfast-monorepo
  1. This will create a new folder named "steadfast-monorepo" in your current directory.
  2. Open/Navigate the monorepo folder in file explorer.

Step 2: Start

Double-click the start-all.bat file or run it from the command prompt.

What it does:

  1. Install all (Recommended for first time setup): Clones the repositories and installs dependencies.
  2. Update, install and run (Recommended when a update is available): Updates all repositories, installs dependencies, and then runs the services.
  3. Run existing version: Runs the existing version of the services without updating or installing anything.
  4. Exit: Exits the script.

What it does:

  1. Starts the steadfast-app at localhost: 5173
  2. Starts the steadfast-api server at localhost: 3000
  3. Starts the flattrade-websocket server at localhost: 8765
  4. Starts the shoonya-websocket server at localhost: 8766

Step 3: Stop

  • To Stop simply close the opened command prompt windows.
  • Or Press any key to stop the app, api and websocket.