Skip to content
This repository has been archived by the owner on Feb 9, 2022. It is now read-only.
/ rush-bot Public archive

Rush is trading bot designed for the end-user, for you, the trader, who wants to quickly implement his strategy in a bot. Rush offers a solution with a focus on simplicity, strategy implementation and backtesting.

License

Notifications You must be signed in to change notification settings

iamfj/rush-bot

Repository files navigation

Rush Trading Bot

Rush is designed for the end-user, for you, the trader, who wants to quickly implement his strategy in a bot. Rush offers a solution with a focus on simplicity, strategy implementation and backtesting.

The open source approach is important for rush to make rapid progress in mapping a wide range of exchanges and indicators. The forum serves as an place for all users and developers to share and discuss ideas, strategies and progress. Rush lives through a community that uses and develops the bot.

Getting Started

(to be continued)

Become a Contributor

If you find a bug or have an idea, please discuss it first in the forum with the other users and the code owner before you start developing. Also, please note our contributing guidelines before submitting your pull request.

The way of a bugfix is

  1. create an issue
  2. submit the pull request
  3. bugfix will be published in the next release

Feel free to discuss the bug in the forum beforehand.

The way of an idea is

  1. create a forum post
  2. wait for the reactions of other users and developers
  3. a ticket will be created
  4. the feature will be planned in a next release
  5. submit a pull request (if you want to implement the feature)
  6. the feature will be published in the next release

Requirements of the Development Environment

Before you start, make sure your development environment meets the following requirements:

  1. Git
  2. Visual Studio Code
  3. Node.js
  4. Yarn
  5. Docker / Docker Compose

It is also a requirement that you have knowledge in all of the above technologies and additionally Javascript, Typescript and Jest.

Setting up your Development Environment

The development environment of our choice is Visual Studio Code. This is the only editor for which the project files may be committed. If your pull request contains files from other editors, the pull request will be rejected.

  1. clone the project to your workspace
  2. install development depencencies yarn install
  3. start coding

Bug / Feature Request

If you find a bug, or want a new feature added, please submit it on the Issues page

Inspiration

Of course, rush is not the first trading bot, there are other fantastic projects before rush. Here is one that Rush was most inspired by:

Thank you for your work and to the trading community.

About

Rush is trading bot designed for the end-user, for you, the trader, who wants to quickly implement his strategy in a bot. Rush offers a solution with a focus on simplicity, strategy implementation and backtesting.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published