47 lines
2.2 KiB
Markdown
47 lines
2.2 KiB
Markdown
# Superalgos Platform
|
|
|
|
The Superalgos Platform provides a visual environment for developing, testing and automating crypto-trading strategies as well as processing markets data and building indicators.
|
|
|
|
|
|
|
|
## Testing Exchanges
|
|
|
|
The version in development 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 Data Capability [*] | Trading Capability [**] |
|
|
| :--- | :---: | :---: |
|
|
| Binance | ☑ | ☑ |
|
|
| Bitfinex | ☑ | ☑ |
|
|
| Bitmex | ☑ | ☐ |
|
|
| HitBTC | ☐ | ☐ |
|
|
| Kraken | ☑ | ☐ |
|
|
| Poloniex | ☐ | ☐ |
|
|
|
|
[*] 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
|
|
|
|
The [Users Manual](https://github.com/Superalgos/Platform/wiki) in this repository's wiki features the documentation corresponding to the latest release.
|
|
|
|
A [new documentation site](https://superalgos.github.io/Documentation/) is in the making, covering the functionality in development.
|
|
|
|
## 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 codebase is distributed with the platform's release, and constitutes a fully functional development environment right out of the package. The platform runs uncompilled on the actual code (```node run``` from the root folder).
|
|
|
|
> If you are testing the version in development, you need to use the workspace in the root directory. Workspaces of older versions do not work in the new one.
|
|
|
|
## 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).
|