49 lines
2.7 KiB
Markdown
49 lines
2.7 KiB
Markdown
# Superalgos Platform
|
|
|
|
The Superalgos Platform provides a visual environment for developing, testing and automating crypto-trading strategies as well as processing market data and building indicators.
|
|
|
|
|
|
|
|
## Exchange Testing Queue
|
|
|
|
The current version opens up the door to working with multiple exchanges and multiple markets. For your reference, this is a quick report on the progress of our tests:
|
|
|
|
| Exchange | Historic Trades Capability [*] | Trading Capability [**] | Comments |
|
|
| :--- | :---: | :---: | :---: |
|
|
| Binance | ☑ | ☑ | You will need an Exchange Key to download Hitoric Trades. |
|
|
| Bitfinex | ☑ | ☑ | Fully tested. Expect 1 year max of Historic Trades. |
|
|
| Bitmex | ☑ | ☐ | We need to implement the concept of Contracts within the system in order to be able to test trading capabilities. |
|
|
| HitBTC | ☐ | ☐ | Not tested yet. |
|
|
| Kraken | ☑ | ☐ | Live trading not tested yet. |
|
|
| Poloniex | ☐ | ☐ | Not tested yet. |
|
|
|
|
[*] The ability to fetch historic data for backtesting purposes has been verified.
|
|
|
|
[**] The ability to run strategies in live-trading mode has been verified.
|
|
|
|
## Documentation
|
|
|
|
Please refer to the [new documentation site](https://docs.superalgos.org/).
|
|
|
|
<!--Developers testing the version in the ```develop``` branch may consult the [develop documentation version](https://superalgos.github.io/Documentation/). This version of the docs is in a permanent work-in-progress state.-->
|
|
|
|
## Codebase and Development Environment
|
|
|
|
To build each release, the Superalgos Platform used to draw code from several repositories within the Superalgos Github organization, as well as from organizations belonging to Teams. This has changed.
|
|
|
|
The ```develop``` branch in this repository now features the latest codebase and development environment.
|
|
|
|
The ```master``` branch in this repository now features the latest stable version of Superalgos.
|
|
|
|
The codebase is distributed with the platform's release and constitutes a fully functional development environment right out of the package. The platform runs uncompiled on the actual code (```node run``` from the root folder).
|
|
|
|
> Use the workspace in the root directory. Workspaces of older versions do not work in the new one. if you are upgrading from an old version, make sure you make a hard refresh of your browser's cache before importing the new workspace.
|
|
|
|
## Contributing
|
|
|
|
We'd love you to join us in the Dev Team. Please see [CONTRIBUTING.md](CONTRIBUTING.md) for the details on how to engage with it.
|
|
|
|
## License
|
|
|
|
The Superalgos Desktop App is open-source software released under [Apache License 2.0](LICENSE).
|