fez5587/Superalgos
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Julian Molina authored and GitHub committed 2019-09-24 15:02:09 +02:00
1 parent 8e6d4cbed7
commit a3f7acff5d
1 file changed
+42 -20
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+42 -20
View File
@@ -15,7 +15,7 @@ Please refer to the [Superalgos Desktop App](https://superalgos.org/tools-supera
* [Getting Started](#getting-started)
* [Before You Begin](#before-you-begin)
* [The Quick Version for Experienced PC Operators](#the-quick-version-for-experienced-pc-operators)
* [The Long Version for Regular Folks on Windows and Mac](#the-long-version-for-regular-folks-on-windows-and-mac)
* [The Extended Version for Regular Folks on Windows and Mac](#the-extended-version-for-regular-folks-on-windows-and-mac)
* [Downloads](#downloads/)
* [Running the App](#running-the-app)
* [Upgrading Your Existing Installation](#upgrading-your-existing-installation)
@@ -107,7 +107,7 @@ The following recommendations may make your life easier using this pre-release i
* We highly recommend you use Chrome to run the app, so that you have a similar environment as developers in case you need help.
* You may need a decent Console / Command Line application for similar reasons: we hope you won't need it, but in case you do, it may save you lots of hassle and make a difference troubleshooting and getting help from the community. We recommend [Console Emulator Cmder](https://cmder.net/).
* You will benefit from having a decent Console / Command Line application for similar reasons: we hope you won't need it, but in case you do, it may save you lots of hassle and make a difference troubleshooting and getting help from the community. We recommend [Console Emulator Cmder](https://cmder.net/).
> Bear in mind that the app evolves fast. We do our best to keep this README up to date, however, some of the images illustrating these explanations may defer from what you will find in the app.
@@ -117,71 +117,93 @@ The following recommendations may make your life easier using this pre-release i
**1. Downloads**:
Download the software package from the [latest software release](https://github.com/Superalgos/DesktopApp/releases/tag/v.0.0.1-alpha) (```Superalgos-Desktop-App.zip```) and extract the file in an accessible route (you will launch the app from these folders).
Download the software package from the [latest software release](https://github.com/Superalgos/DesktopApp/releases/tag/v.0.0.2-alpha) (```Superalgos-Desktop-App.zip```) and extract the file in an accessible route (you will launch the app from these folders).
Download historic market data from the [latest data release](https://github.com/Superalgos/DesktopApp/releases/tag/data.poloniex.btc.usdt.2019.08.27) (```Poloniex.BTC.USDT.Historic.Data.zip```) and extract the file inside the ```Superalgos Desktop App``` folder generated by the software package ZIP.
Download historic market data from the [latest data release](https://github.com/Superalgos/DesktopApp/releases/tag/data.poloniex.btc.usdt.2019.09.24) (```Poloniex.BTC.USDT.Historic.Data.zip```) and extract the file inside the ```Superalgos Desktop App``` folder generated by the software package ZIP.
You should end up with the following folder structure:
![image](https://user-images.githubusercontent.com/13994516/63965100-be6a7b80-ca98-11e9-9398-40b46be9ecf5.png)
![image](https://user-images.githubusercontent.com/13994516/65512836-56158b00-deda-11e9-8d81-0dcd79efb480.png)
> Make sure the data ended up as the ```Data-Storage``` folder, right inside ```Superalgos Desktop App```
> Make sure the data ended up as the ```Data-Storage``` folder, right inside the ```Superalgos Desktop App``` root folder.
**2. Continue with [Running the App](#running-the-app)**
> NOTE FOR DEVELOPERS: Instead of using the EXE file to run the app, you may want to use ```node server.js``` from within the ```WebServer``` folder to run on your full Node Js installation.
> NOTE FOR DEVELOPERS: Instead of using the EXE file to run the app, you may want to use ```node run``` from within the root ```Superalgos Desktop App``` folder, to run on your full Node Js installation.
## The Long Version for Regular Folks on Windows and Mac
## The Extended Version for Regular Folks on Windows and Mac
### Downloads
**1. Download the Software Package**:
Go to the [latest Superalgos Desktop App release](https://github.com/Superalgos/DesktopApp/releases/tag/v.0.0.1-alpha) and download ```Superalgos-Desktop-App.zip```.
Go to the [latest Superalgos Desktop App release](https://github.com/Superalgos/DesktopApp/releases/tag/v.0.0.2-alpha) and download ```Superalgos-Desktop-App.zip```.
**2. Extract the ZIP file**:
How you extract/unpack the files depends on the software you use to handle ZIP files. Double clicking the ZIP file should work in most scenarios, however, some systems may "open" the file instead of "extracting" it. Make sure you are "extracting" and not just "opening" the file. You may also right-click the file and check the options available on the menu.
How you extract/unpack the files depends on the software you use to handle ZIP files. Double clicking the ZIP file should work in most scenarios, however, some systems may "open" the file instead of "extracting" it. Make sure you are "extracting" and not just "opening" the file. You may also right-click the file and check the options available on the pop-up menu.
When you extract the ZIP file, a folder structure will be created with the root folder being ```Superalgos Desktop App```.
You may extract/unpack the files in any location of your drive, however, we recommend unpacking in an accesible route *(i.e.: ```C:\```)*, as you will later need to fit an additional folder in the ```Superalgos Desktop App``` folder, and you will also need to access these folders every time you launch the app.
You may extract/unpack the files in any location of your drive, however, we recommend unpacking in an accesible route *(i.e.: ```C:\```)*, as you will later need to fit an additional folder inside the ```Superalgos Desktop App``` folder, and you will also need to access these folders every time you launch the app.
**3. Download the Data Package**:
For your convenience and [for the reasons explained](https://superalgos.org/tools-superalgos-desktop-app.shtml#expectations) in the Superalgos Desktop App page on the website, we maintain a downloadable market data file that you can download, so that you may be up and running as quickly as possible.
For your convenience and [for the reasons explained](https://superalgos.org/tools-superalgos-desktop-app.shtml#expectations) in the Superalgos Desktop App page on the website, we maintain a downloadable market-data file that you can download, so that you may be up and running as quickly as possible.
Go to the [latest Data release](https://github.com/Superalgos/DesktopApp/releases/tag/data.poloniex.btc.usdt.2019.08.27) and download ```Poloniex.BTC.USDT.Historic.Data.zip```.
Go to the [latest Data release](https://github.com/Superalgos/DesktopApp/releases/tag/data.poloniex.btc.usdt.2019.09.24) and download ```Poloniex.BTC.USDT.Historic.Data.zip```.
The ZIP file includes highly-compressed complete historic BTC/USDT market data at Poloniex. Expect decompression to take from 30 to 60 minutes, depending on your system. Once you have the historic data, the app will make sure the data stays up to date.
**4. Extract the ZIP file**:
You need to extract the file inside the ```Superalgos Desktop App``` folder generated by the first ZIP file. You can do this either moving ```Poloniex.BTC.USDT.Historic.Data.zip``` inside the ```Superalgos Desktop App``` folder and selecting ```Extract here``` from the menu poping up upon right-clicking the file, or by extracting anywhere else and the moving the resulting ```Data-Storage``` folder inside the ```Superalgos Desktop App``` folder.
You need to extract the file inside the ```Superalgos Desktop App``` folder generated by the first ZIP file. You can achieve this in two ways:
A. Move ```Poloniex.BTC.USDT.Historic.Data.zip``` inside the ```Superalgos Desktop App``` folder, right-click the ZIP file and select ```Extract here``` in the pop-up menu. This is the quickest method.
B. Extract the ZIP file anywhere else and then move the resulting ```Data-Storage``` folder inside the ```Superalgos Desktop App``` folder. This will take almost double the time.
You should end up with the following folder structure:
![image](https://user-images.githubusercontent.com/13994516/63965100-be6a7b80-ca98-11e9-9398-40b46be9ecf5.png)
![image](https://user-images.githubusercontent.com/13994516/65512836-56158b00-deda-11e9-8d81-0dcd79efb480.png)
> Make sure the data ended up as the ```Data-Storage``` folder, right inside ```Superalgos Desktop App```
> Make sure the data ended up as the ```Data-Storage``` folder, right inside the ```Superalgos Desktop App``` root folder.
### Running the App
**1. Use the executable to Run the App**
**1. Use the executable file to run the app**
Go to ```Superalgos Desktop App\WebServer```, that is, the ```WebServer``` folder inside the ```Superalgos Desktop App``` folder and double click on ```Windows-Superalgos-Desktop.exe``` (for Windows systems) or ```MacOs-Superalgos-Desktop.app``` (for Mac systems).
Go to the ```Superalgos Desktop App``` folder and double click on ```Superalgos.exe``` (for Windows systems) or ```Superalgos.app``` (for Mac systems).
The app will load on your default browser. You should either [set Chrome as your default browser](https://support.google.com/chrome/answer/95417?co=GENIE.Platform%3DDesktop&hl=en) before executing the EXE file, or simply close the non-Chrome browser, open Chrome and go to http://localhost:1337/.
The app will load on your default browser. You should either [set Chrome as your default browser](https://support.google.com/chrome/answer/95417?co=GENIE.Platform%3DDesktop&hl=en) before executing the file, or simply close the non-Chrome browser, open Chrome and go to http://localhost:1337/.
Also, a Console/Command Line window will open. The Console must be open for as long as the app is running. Do not close the window or stop the processes running on it. You may minimize the Console if your Operating System allows you to do so.
> Closing the Console/Command Line may cause your market data to become corrupt. The proper way of closing the application is closing your browser first, and allow a minute for processes to stop before closing the Console.
**2. Drag and drop an example workspace**:
Go to the ```Superalgos Desktop App/Quick-Start-Examples``` folder, drag the file ```Share - Workspace - A Minimum Strategy Template.json``` and drop it on the _Designer_ (in the bottom half of the screen, the area with a black background) to start with a working template.
![Installation-Drag-Workspace](https://user-images.githubusercontent.com/13994516/64358772-5ae7cd00-d007-11e9-9250-77540cc351c8.gif)
**3. Start indicators**:
That's it! You are up and running!
Now you are ready to learn the basic operation of the app so that you may run your first backtests or trade live with existing strategies.
**3. Start processes**:
| Task Manager | Definition |
| :---: | :---: |
| ![parameters](https://user-images.githubusercontent.com/13994516/63508921-3f46d780-c4db-11e9-970d-8d5e2ca5ebe3.png) | ![definition](https://user-images.githubusercontent.com/13994516/63503991-deb29d00-c4d0-11e9-8c03-bf2e618f9ef6.png) |
Open up the Designer section of the app by dragging the horizontal bar upwards and locate the Task Manager element connected to the Definition element. Then, hover your mouse pointer over the Task Manager element and click ```Run All Tasks``` in the menu.
> To move around the Designer, click on the black background and drag to pan in any direction.
You will find the Task Manager element in the following position:
[PNG ILLUSTRATION PLACEHOLDER]
Click the RESTART SIMULATION button on the right-hand side of the horizontal turquoise bar. This puts all indicator bots to run. The data files you downloaded contain data files up to a certain point in time. You will need to allow some time for bots to catch up with building candles and the rest of indicators up to the present time. After a few minutes, refresh the candles layers as explained in the [Layers Panel](#layers-panel) section.