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

For the most up-to-date status of features and implementations, please refer to our Status Page.

App Screenshots

Light Mode

Dark Mode

App Settings

LTP Range Bar

One Click Trading Keys

Add Broker

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

2. Ensure Node.js v21.7.3 and npm v10.5.0 are installed and accessible from the command line.

node -v && npm -v

3. 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

3. This will create a new folder named "steadfast-monorepo" in your current directory.
4. 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.

📜 License

This project is licensed under a Custom Free Use, No Commercialization License. It allows free use for personal and non-commercial purposes. Commercial use is possible but requires explicit permission and a revenue-sharing agreement with the project creator. For full license terms, please see the LICENSE file in this repository.

🤝 Contributing

Contributions are welcome! If you find any issues or want to add enhancements, feel free to submit a pull request. Please read our contribution guidelines before submitting your changes. By contributing to this project, you agree that your contributions will be licensed under the same license terms as the project.

☕ Donate

If you find this project useful, consider showing your support! Your donations help maintain and improve the project. 😄

You can donate using UPI (Unified Payments Interface):

Scan the QR code below to make a UPI payment:

Thank you for your support!