117 lines
4.6 KiB
Markdown
117 lines
4.6 KiB
Markdown
|
|
|
|
# What is Superalgos?
|
|
|
|
Superalgos is a platform to automate crypto-tarding. It is a Nodejs + Web App that runs at your hardware and scales from a single Raspberry Pi to a Trading Farm. Superalgos is Free and Open Source.
|
|
|
|
## Superalgos Features
|
|
|
|
* A Visual Scripting Designer.
|
|
* Integrated Charting System.
|
|
* Task Managment across a Trading Farm.
|
|
* Community built strategies to learn and start from.
|
|
|
|
## Superalgos allows you to
|
|
|
|
* Visually design your own trading strategies.
|
|
* Visually design your own indicators.
|
|
* Visually design your own plotters to visualize your indicators.
|
|
* Download historical market data from crypto exchanges.
|
|
* Backtest your strategies against historical data.
|
|
* Run live trading sessions.
|
|
|
|
# Superalgos for Developers
|
|
|
|
* You are free to custumize Superalgos for your customers. No royalties, no license fees.
|
|
* Everything extra your customers might need you can code it yourself or request it as new features.
|
|
* You can use Superalgos as a platform or a component of a larger system.
|
|
* No propietary code / libraries. All open source and free.
|
|
* Already available a set of community contributed plugins (workspaces, strategies, indicators, plotters, tutorials, etc.)
|
|
|
|
# Superalgos is user's centric
|
|
|
|
* No ads, anywhere.
|
|
* No sign up / logins.
|
|
* No usage data collection of any kind.
|
|
* Runs on 100% uncompilled code you can read and audit.
|
|
|
|
## Superalgos saves you time
|
|
|
|
* No need to code the download of historical data from crypto exchanges.
|
|
* No need to code the streming of market data from crypto exchanges.
|
|
* No need to hardcode strategies, use the visual designer for a more flexible approach.
|
|
* No need to debug what went wrong line by line or diving into log files with tons of data. You can see each variable of the state of the Trading Engine at every candle by hovering the mouse over the charts.
|
|
* No need to integrate a charing library, Superalgos has its own integrated Charting System.
|
|
* No need to manage task data or execution dependencies by yourself. Superalgos allows you to define Tasks and distribute them acrross a Trading Farm, and it takes cares of the data and execution dependencies, so that each task automatically starts when their dependencies are ready.
|
|
|
|
# Getting Started
|
|
|
|
## Instalation
|
|
|
|
1. If you don't have it yet, [install Node.js.](https://nodejs.org/en/download/)
|
|
2. Open a command prompt or terminal and type:
|
|
|
|
```
|
|
git clone https://github.com/Superalgos/Superalgos
|
|
```
|
|
|
|
## Usage
|
|
|
|
1. Change to the Superalgos directory and type:
|
|
```
|
|
node run
|
|
```
|
|
2. Follow the in-app Welcome Tutorial to learn the basics.
|
|
|
|
## Uninstall
|
|
|
|
Just delete the folder Superalgos.
|
|
|
|
# Support
|
|
|
|
### Via Telegram
|
|
|
|
We give online support to users through our [Superalgos Telegram Community](https://t.me/superalgoscommunity).
|
|
|
|
We give support to developers through our [Superalgos Telegram Developer's Group](https://t.me/superalgosdevelop)
|
|
|
|
We give support in Spanish through our [Superalgos en Español Telegram Developer's Group](https://t.me/superalgos_es)
|
|
|
|
### Self Service via Documentation Site
|
|
|
|
Superalgos is well documented. Please visit the [Documentation Site](https://docs.superalgos.org/) to learn about Superalgos.
|
|
|
|
### Self Service via Video Tutorials
|
|
|
|
Some topics have video tutorials. Please visit the [Superalgos You Tube Channel](https://www.youtube.com/channel/UCmYSGbB151xFQPNxj7KfKBg) to learn more about Superalgos.
|
|
|
|
# Contributing
|
|
|
|
Superalgos is a Community Project. Learn [how to become a Contributor](https://docs.superalgos.org/contributing-to-superalgos.html).
|
|
|
|
## Contributors
|
|
|
|
Luis Fernando Molina, Julian Molina, Andreja Cobeljic, Matías Benitez, Ira Miller, Eduardo Remis, Jeff Braun, rico4dev, Barry Low, Nikola Bjelogrlic, Hirajin Koizuko, Francisco J. Santillán, Viktoria B., Javier A., Gustavo J., Romina, Pedro P., Thais M., Loui M., Natalia M., Bashar A., Carlos V., Diego M., Sebastian E., Bogdan P., Marko V., Igor S., Niksa K., Rodrigo M. and Nicanor M.
|
|
|
|
# Other Resources
|
|
|
|
### Web Site
|
|
|
|
For an overview of what Superalgos can do for you, please check the [Superalgos Website] (https://superalgos.org/)
|
|
|
|
### Superalgos Blog
|
|
|
|
You can find everything we wrote during the history of the project at the [Superalgos Blog] (https://medium.com/superalgos)
|
|
|
|
### Superalgos on Twitter
|
|
|
|
To stay up-to-date, follow [Superalgos on Twitter] (https://twitter.com/superalgos)
|
|
|
|
### Superalgos on Facebook
|
|
|
|
To stay up-to-date, follow [Superalgos on Facebook] (https://www.facebook.com/superalgos)
|
|
|
|
# License
|
|
|
|
Superalgos is open-source software released under [Apache License 2.0](LICENSE).
|