Contributing Brokerages

Setting Up Your Environment

Introduction

This page explains how to set up your coding environment to create, develop, and test your brokerage before you contribute it to LEAN.

Prerequisites

Working knowledge of C#. You also need to install .NET 6.0.

Set Up Environment

Follow these steps to set up your environment:

  1. Fork Lean and then clone your forked repository to your local machine.
  2. Open the Lean.Brokerages.Template repository and click Use this template.
  3. On the Create a new repository from Lean.Brokerages.Template page, set the repository name to Lean.Brokerages.<brokerageName> (for example, Lean.Brokerages.XYZ).
  4. Click Create repository from template.
  5. Clone the Lean.Brokerages.<brokerageName> repository.
  6. $ git clone https://github.com/username/Lean.Brokerages.<brokerageName>.git
  7. If you're on a Linux terminal, in your Lean.Brokerages.<brokerageName> directory, change the access permissions of the bash script.
  8. $ chmod +x ./renameBrokerage
  9. In your Lean.Brokerages.<brokerageName> directory, run the renameBrokerage.sh bash script.
  10. $ renameBrokerage.sh

    The bash script replaces some placeholder text in the Lean.Brokerages.<brokerageName> directory and renames some files according to your brokerage name.

You can also see our Videos. You can also get in touch with us via Discord.

Did you find this page helpful?

Contribute to the documentation: