Update README.md
This commit is contained in:
Julian Molina authored and GitHub committed
1 parent
9c80848385
commit
8f6ecee053
1 file changed
+46
-16
@@ -109,41 +109,71 @@ The following recommendations may make your life easier using this pre-release i
|
||||
|
||||
> **WARNING: The Superalgos Desktop App is at a very early stage of development. As such, errors may occur at any point, including errors that can cause you to lose money. You are responsible for taking all precautions before starting trading live. Make sure you test with small amounts of money, the kind you can afford losing. Trade live at your own risk.**
|
||||
|
||||
## Installing / Running the App
|
||||
## The Quick Version for Experienced PC Operators
|
||||
|
||||
**1. Download the multi-part ZIP file**:
|
||||
**1. Downloads**:
|
||||
|
||||
Go to the [latest release](https://github.com/Superalgos/DesktopApp/releases/tag/v.0.2.0-alpha) and download all of the multi-part files with a ZIP extension.
|
||||
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 in an accessible route (you will launch the app from these folders).
|
||||
|
||||
**2. Extract the ZIP files**:
|
||||
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 inside the ```Superalgos DEsktop App``` folder generated by the software package ZIP.
|
||||
|
||||
Right-click on the first multi-part ZIP file and extract / unpack the files. The ZIP files include highly-compressed complete historic market data. Expect decompression to take from 4 to 8 hours, depending on your system. Decompressing overnight may be a good idea, as your drive will be quite busy for some time, potentially slowing down your system. The reason why the package is so heavy is because it contains market data. Once you have the data, subsequent updates are a lot lighter.
|
||||
**2. Continue with [Running the App](#running-the-app)
|
||||
|
||||
**3. Run your web server and 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.
|
||||
|
||||
Open your console / command line app and go to directory ```WebServer``` (a folder in the root of the zip files you previously decompressed); assuming you are starting the console from the root directory of the app, the command to access WebServer is:
|
||||
## The Long Version for Regular Folks on Windows and Mac
|
||||
|
||||
```
|
||||
cd WebServer
|
||||
```
|
||||
### Downloads
|
||||
|
||||
Once inside WebServer, continue with this command:
|
||||
**1. Download the Software Package**:
|
||||
|
||||
```
|
||||
node server.js
|
||||
```
|
||||
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```.
|
||||
|
||||
**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 wrk in most scenarios. You may also right-click the file and check the options available on the 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 rocommend 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.
|
||||
|
||||
**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.
|
||||
|
||||
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```.
|
||||
|
||||
The ZIP file includes highly-compressed complete historic BTC/USDT market data at Poloniex. Expect decompression to take from 1 to 2 hours, 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 should end up with the following folder structure:
|
||||
|
||||
|
||||
|
||||
### Running the App
|
||||
|
||||
**1. Use the EXE 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).
|
||||
|
||||
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/.
|
||||
|
||||
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.
|
||||
|
||||
###
|
||||
|
||||
**4. Drag and drop an example workspace**:
|
||||
|
||||
Drag one of the sample _workspaces_ in the ```/Quick-Start-Examples``` folder 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.
|
||||
Drag one of the sample _workspaces_ in the ```Superalgos Desktop App/Quick-Start-Examples``` folder 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.
|
||||
|
||||
|
||||
|
||||
**5. Start indicators**:
|
||||
|
||||
Click the RESTART SIMULATION button on the right-hand side of the horizontal turquoise bar. This puts all indicator bots to run. The ZIP 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.
|
||||
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.
|
||||
|
||||
That's it! You are up and running!
|
||||
|
||||
|
||||
Reference in new issue
Block a user