Getting Started with FiSDK: From GitHub to Local Deployment

FiSDK provides a simple and powerful interface for interacting with the Fintechee trading platform. For traders and developers eager to build custom dashboards or test trading strategies, understanding how to set up FiSDK locally is the first step. This guide walks you through downloading, configuring, and running FiSDK from the GitHub repository to a local web server environment.

Overview of the FiSDK GitHub Repository

The FiSDK GitHub repository is the central resource for developers and traders. It includes:

  • Dashboard templates (dashboard.html)

  • JavaScript logic files (ui.js)

  • Example scripts demonstrating common API calls

  • Documentation for API usage and best practices

The repository serves as a starting point for both building custom dashboards and experimenting with FiSDK’s event-driven APIs.

Downloading and Unzipping the Project

To get started:

  1. Visit the FiSDK GitHub Repository

  2. Click “Code” → “Download ZIP”

  3. Unzip the project to a local folder on your computer

This process provides a fully functional local copy of the project, ready to be loaded in a web server environment.

Running FiSDK with a Simple Web Server

FiSDK requires a web server to run correctly, even for local testing. You can use lightweight servers such as:

  • Python HTTP server (Python 3.x):

  • cd path/to/fisdk
    python -m http.server 8000
  • Node.js server (using http-server):

  • npm install -g http-server
    http-server path/to/fisdk

Once the server is running, open your browser and navigate to http://localhost:8000/dashboard.html to access the dashboard interface. This setup allows you to interact with FiSDK APIs, test events, and visualize real-time data.

Repository Examples and Learning Paths

The repository includes several examples to help beginners understand FiSDK’s functionality:

  • Real-time position tracking

  • Order execution subscriptions

  • Custom alerts and notifications

  • Dashboard UI updates

By studying and modifying these examples, users can quickly grasp the basics of FiSDK and expand their knowledge with more complex operations.

Recommended Workflow for Beginners

  1. Start small: Begin with one example, such as subscribing to an order event

  2. Experiment incrementally: Modify the JavaScript logic to see immediate results

  3. Build your dashboard: Combine UI elements with FiSDK calls for real-time interaction

  4. Test thoroughly: Use the provided test white-label accounts for safe experimentation

  5. Expand gradually: Add more functionality, such as risk monitoring or custom reporting

Following this workflow ensures a smooth learning curve and helps traders and developers build confidence with FiSDK before creating full-scale applications.