Merge pull request #1367 from Luis-Fernando-Molina/develop

Contribution: Changes in Readme, INSTALL.md, and configurable docs page for any node.
This commit is contained in:
Luis Fernando Molina authored and GitHub committed 2021-08-05 04:40:18 -04:00
commit b623c88b9b
8 files changed
+2750 -711

No files matched your search

+1
View File
@@ -143,6 +143,7 @@ try {
console.log("What's next? This is the current development pipeline:")
console.log('')
console.log('Superalgos P2P Network ...................................... Will allow algo-traders to share trading signals with Superalgos users consuming these signals via a mobile app.')
console.log('Real-time Trading Signals ................................... Will allow users to emit trading signals and be rewarded with SA Tokens.')
console.log('Superalgos Mobile ........................................... Will allow users to consume trading signals for free and autonomously execute trades from their mobile phones.')
console.log('Ethereum Integration ........................................ Will allow mining data from an Ethereum network node, and bring it into the Superalgos workflow.')
+357
View File
@@ -0,0 +1,357 @@
# Getting Started Guide
All procedures are the same for Windows, Linux, or Mac OS. Raspberry Pi terminal commands have been included for ease of use.
> **IMPORTANT:** Remote installations and minimalist hardware —both virtual and physical— are better suited for production deployments, where the use of the GUI is minimal. We highly recommend learning Superalgos in a local installation. Mastering the system takes time, and the use of the GUI to go through in-app tutorials is crucial during the learning process. Your experience will be orders of magnitude better if you follow this advice: leave remote installations and minimalist hardware for when you are ready to start trading live.
# Pre-Requisites
## 1. Node JS Installation
If you don't have it yet, download and install Node.js.
Node JS is an open-source server environment required to run Superalgos.
**A.** Go to the Node JS [download page](https://nodejs.org/en/download/).
**B.** Download your system’s installer. Select *LTS Recommended for Most Users* and click the big Windows or macOS Installer button. If you are on Linux, the installer is listed further down the page.
**C.** Run the installer with the default configuration — just click Next until Node.JS is fully installed. That's it! You can continue with step 2 (Git Installation).
<hr>
**NODE JS INSTALLATION FOR RASPBERRY PI USERS**
You may install Node.JS just like you would on any other machine as per the above instructions. As an alternative, you may also try the following from the SSH Terminal.
**NOTE:** It is best to use the most current and updated version of the FULL PiOS image.
```
curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
```
Followed by:
```
sudo apt-get install -y nodejs
```
It is also required to install the Node Package Manager for dependancy management.
```
sudo apt install npm
```
You may also type the following to verify Node.js and NPM installation and version.
```
node -v
```
```
npm -v
```
<hr>
## 2. Git Installation
Download and install Git.
Git is an open-source distributed version control system required to download and stay up to date with Superalgos.
**A.** Go to the Git [download page](https://git-scm.com/downloads).
**B.** Download the version for your Operating System.
**C.** Run the installer with the default configuration — just click Next until Git is fully installed.
**IMPORTANT:** The latest version of Git is required to handle the authentication with GitHub.com.
**NOTE FOR MAC USERS:** Depending on your setup, installing Git may be optional. The native XCode Command Line Developer Tools seems to work well. If you do install Git, we have tested Tim Harper's binary installer successfully.
<hr>
**GIT INSTALLATION FOR RASPBERRY PI USERS**
Just like with Node.JS, you may follow the above instructions to install Git, or use the SSH Terminal command. The most recent version of PiOS has Git already installed, so this may give you an error. The error will not affect your installation.
```
sudo apt-get install git
```
<hr>
## 3. Google Chrome or Safari
Use Chrome, or Safari on Mac. These are the only tested browsers.
**A.** Go to the Chrome [download page](https://www.google.com/chrome/).
**B.** Run the installer.
Before you begin, it is recommended that you set up Chrome/Safari as your default browser.
**IMPORTANT:** Use Chrome/Safari so that you have a similar environment as the dev team in case you need help. We are not testing on any other browsers, and it is a well-known fact that browsers behave differently.
# Superalgos Client Installation
## 1. Fork the Superalgos Repository
**A.** Scroll the page all the way to the top. Find and click the **Fork** button to create your fork/copy of this repository. To fork Superalgos you need a Github account. If you don't have one, go ahead and create it.
**NOTE:** A Fork is required for your contributions to the project. The reason why Superalgos is free and open-source is that the project has set up a <a href="https://superalgos.org/community-business.shtml" target="_blank">Collective Business</a> in which all users may participate. The way to participate is to <a href="https://superalgos.org/community-contribute.shtml" target="_blank">contribute</a> to make Superalgos better. The project's <a href="https://superalgos.org/token-overview.shtml" target="_blank">token</a> is distributed among contributors.
## 2. Clone Your Fork
**A.** Once the fork is created, you will land on the page of your fork. Copy the URL from your browser's address bar.
**B.** In your computer/laptop/server, open a command prompt or terminal. Make sure you are in a directory where you have write permissions (on most systems the terminal will open in your user’s home directory, so you’re good). Clone the git repository using the command:
```
git clone <URL of your Superalgos fork>
```
For example, if your Github username is John, the command will look like this:
```
git clone https://github.com/John/Superalgos
```
This creates the `Superalgos` folder in the current directory, which contains the whole installation.
## 3. Install Node Dependencies
**A.** After the Superalgos directory has been installed, the final step of installation is to set up the necessary node dependencies.
**B.** In the same command prompt or terminal you just used, type the following command:
```
node setup
```
Then wait until you are able to type within the terminal again.
This command will install and configure all additional dependencies needed by Superalgos. It will also install desktop and start menu shortcuts.
**NOTE FOR USERS INSTALLING MULTIPLE INSTANCES OF SUPERALGOS ON THE SAME MACHINE:** In order to avoid name conflicts between shortcuts, make sure to rename each Superalgos directory before running `node setup`.
Congratulations your installation is complete!
> **The Usage section below explains how to run the app.**
<hr>
**DEPENDENCY INSTALLATION FOR RASPBERRY PI USERS**
As noted above, running `node setup` installs GUI shortcuts by default. To suppress this behavior in headless installations, add the `noShortcuts` flag as follows:
```
node setup noShortcuts
```
<hr>
**Troubleshooting Dependency Installation**
If you are having difficulty running the node setup command here are a few common issues that may be getting in the way.
**1.** Check the version of node and npm you have installed. Make sure that you are running an updated version of node greater than version 12 and npm greater than version 5. You can check which version you have by typing `node -v` and `npm -v` into a command prompt or terminal. If your version numbers are below these, you can update your installation by following the instructions outlined in the "Node JS Installation" step above.
**2.** If you are installing Superalgos in an administratively protected directory you will need to do one of the following:
- For Windows start your command prompt as an administrator.
- For Linux and Mac Systems make sure to add the sudo command to node setup. This will look like `sudo node setup`.
**3.** For Windows it is important that you have C:\Windows\System32 added to your global PATH. For instructions on how to do this google "add to the path on Windows 10."
<hr>
## 4. Installation Notes
**A.** You need to make a fork so that you may contribute work. Superalgos is a Community project and you are expected to contribute, like everyone else. You don't need to be a technical person to contribute. Fixing a typo in the docs or translating a paragraph into your native language are valuable contributions too. Superalgos has built-in features that make contributing easy. Help make Superalgos better and Superalgos will better serve you! [Free-riding is not cool](https://en.wikipedia.org/wiki/Free-rider_problem), particularly on free, open-source, Community-driven projects.
**B.** The software includes an in-app self-update command / feature. It will help you stay up-to-date with the latest version of the software. Updates are on-demand, so don't worry about undesired updates. The project moves very fast and new features become available regularly, particularly if you choose to run the software in the ```develop``` branch (you may switch branches from within the app).
**C.** It is a good idea to perodically run the `node setup` command to keep the underlying dependencies for your Superalgos installation up to date.
**D.** Before installing the client on a remote computer in an attempt to access the UI from a different machine, we highly recommend you do a standard installation on your PC / laptop first. Leave your Raspberry Pi or VPS for later, once you have done all available tutorials. This single tip will save you a lot of time: you don't need to add complexity before you learn how to handle the app, and the GUI performs best in a local installation.
# Usage
## 1. Run the Client and GUI
**A.** To run Superalgos, go to the Superalgos directory/folder and run this command:
```
node run
```
The Client will run on your terminal and the GUI will launch on your default browser. If Chrome/Safari is not your default browser, copy the URL, close the browser, open Chrome/Safari, and paste the URL. Be patient... it takes a few seconds to fully load the GUI.
A Welcome Tutorial pops-up automatically. You must do this Tutorial to finish the setup and to learn the basics. It's the ultimate onboarding experience, superior to all other resources available, including videos and the Docs.
![run-the-system-01](https://user-images.githubusercontent.com/13994516/107037804-e5fc6200-67bb-11eb-82f2-d0f40247fa14.gif)
If you are running a headless Raspberry Pi (one without a screen) you may need to change directories first and run Superalgos with the `minMemo` and `noBrowser` options.
```
cd Superalgos
```
then
```
node run minMemo noBrowser
```
In addition, you may use any of the automatically installed desktop and start menu shortcuts to launch Superalgos.
**NOTE:** Shortcuts are not currently supported on Mac. Collaborators are needed to finish this feature.
**B.** Enable Desktop Shortcut on Ubuntu
The majority of shortcuts that are automatically installed will work out of the box. Desktop shortcuts on Ubuntu, however, require a few additional steps to set up.
First, desktop icons need to be enabled within the Tweaks app.
* Check if Tweaks is installed.
* If not go to Ubuntu Software.
* Install Tweaks.
* Open Tweaks.
* Under extensions turn on Desktop Icons
![enable-ubuntu-shortcut](https://user-images.githubusercontent.com/55707292/117553927-f0780300-b019-11eb-9e36-46b509653283.gif)
**TIP:** If you do not see the desktop shortcut appear right away you may need to restart your computer.
Finally, you will need to enable the desktop shortcut.
* Right click Superalgos.desktop and select Allow Launching.
![allow-launching](https://user-images.githubusercontent.com/55707292/117553933-fcfc5b80-b019-11eb-872c-4fad81b184d2.gif)
Now both launcher and desktop shortcuts will launch Superalgos like any other program on your computer.
## 3. Usage Notes
We are testing the UI on Google Chrome and Safari on macOS only. It may work on other browsers as well &mdash; or not. If you are running on a different browser and ever need support, make sure you mention that fact upfront, or even better, try on Chrome/Safari first.
**TIP:** If your computer has 8 GB of RAM or less, use ```node run minMemo``` to run the system with minimal RAM requirements.
# Running Superalgos on a Headless Linux Server as a Daemon
If you’re running Superalgos on a headless linux server like a Raspberry Pi, you might want to run it as a daemon so it isn’t attached to your current login session. The easiest, most standard way to go about this is probably using `systemd`. Most linux distributions use it as default init system/service manager.
## Using `systemd`
Create a `superalgos.service` file looking like this (change `<user>` to your user name and `/path/to/Superalgos` to your Superalgos folder, for instance `/home/John/Superalgos`):
```
[Unit]
Description=Superalgos client
[Service]
Type=simple
User=<user>
WorkingDirectory=/path/to/Superalgos
ExecStart=/usr/bin/node run minMemo noBrowser
[Install]
WantedBy=multi-user.target
```
There is no need to run Superalgos as root so we’re running it as a user. The `minMemo` option assumes you’re running on a small machine like a Raspberry Pi, while `noBrowser` makes sense for running daemonized.
Now, as root (or using `sudo`), put the file `superalgos.service` you just created in `/etc/systemd/system/` and issue the command
```
systemctl enable superalgos
```
This will install the service so that Superalgos is started on boot. To start it manually, do (again as root or with `sudo`)
```
systemctl start superalgos
```
To see the output of Superalgos, use
```
journalctl -u superalgos
```
or to follow the output,
```
journalctl -u superalgos -f
```
# Uninstall
Superalgos writes nothing outside of the ```Superalgos``` folder other than shortcut files. To uninstall the software, follow these steps:
Open a terminal or command prompt and navigate to your main Superalgos directory and type the following command:
```
node uninstall
```
This will remove any shortcut files that have been installed.
Then simply delete the `Superalgos` folder. There will be nothing left on your computor.
# Welcome Tutorial
Once the app finishes loading, an interactive tutorial takes you by the hand and walks you all around the system while you learn the basic skills required to use the interface, mine data, backtest strategies, and even run a live trading session. It is highly recommended you follow the tutorial until the end, as it is carefully crafted to make your onboarding as easy as possible. Tutorials are the absolute best way to tackle the learning curve. You should do all tutorials before you start exploring other avenues on your own.
![welcome-tutorial-00](https://user-images.githubusercontent.com/13994516/107038771-4a6bf100-67bd-11eb-92e0-353525a972a9.gif)
**NOTE:** The tutorial uses Binance or Binance US as the exchange of choice. If you don’t have an account with Binance or Binance US, you will still be able to follow 100% of the tutorial. When you get to the live trading section, keep going even if you don't intend to run the session. You may learn how to work with other exchanges later on.
# Docker Deployments
Docker container images can be found at https://github.com/users/Superalgos/packages/container/package/superalgos
If you wish to run Superalgos over docker platform, follow these steps.
**Note:** This has not been extensively tested yet. If you run into troubles, please contact us at the [Superalgos Support Group](https://t.me/superalgossupport).
## 1. Install Docker
Follow the link to [install docker](https://docs.docker.com/engine/install/).
## 2. Run
### Option A. Using pre-built container
You will need to create local storage directories beforehand, by example with `mkdir Data-Storage Log-Files My-Workspaces`
```
docker run \
-d \
--rm \
--name superalgos \
-p 18041:18041 \
-p 34248:34248 \
-v $(pwd)/Data-Storage:/app/Data-Storage \
-v $(pwd)/Log-Files:/app/Log-Files \
-v $(pwd)/My-Workspaces:/app/My-Workspaces \
ghcr.io/superalgos/superalgos:latest
```
Now you can access the Superalgos UI at http://127.0.0.1:34248
To see console logs you can use `docker logs superalgos -f`
When you're done just exec `docker kill superalgos`
### Option B. Build container locally using docker-compose
Follow the link to [install docker-compose](https://docs.docker.com/compose/install/)
Run `docker-compose -f Docker/docker-compose.yml up`.
## Configure the Container Environment
### Available image tags
To avoid breaking changes, the `shasum hash` and the `release` tags are the best to use. These will generally ensure you are always running the same code. The other tags will change which code they are pointing to more frequently and without notice.
- `latest` : the absolute latest build
- `master` : the latest master branch build
- `develop` : the latest develop branch build
- `<shasum hash>` : a specific git commit hash
- `<release>` : corresponds with a Github Release (git tag), i.e. `beta-10`
### Environment variables
`PUID` and `GUID` environment variables can be used to help avoid permissions issues in the mounted volumes between the container environment and the local OS environment. The default `PUID` and `GUID` is `1000`. You can view the current user's PUID and GUID with the `id` command.
## Troubleshooting
Some users have reported the Docker installation was not working, and the root cause was that the ad blocker was blocking the scripts to run.
@@ -643,9 +643,15 @@ function newFoundationsActionSwitch() {
break
case 'Open Documentation':
{
let definition = getSchemaDocument(action.node)
if (definition !== undefined) {
UI.projects.education.spaces.docsSpace.openSpaceAreaAndNavigateTo(action.node.project, 'Node', action.node.type)
let docs = UI.projects.foundations.utilities.nodeConfig.loadConfigProperty(action.node.payload, 'docs')
if (docs === undefined) {
let definition = getSchemaDocument(action.node)
if (definition !== undefined) {
UI.projects.education.spaces.docsSpace.openSpaceAreaAndNavigateTo(action.node.project, 'Node', action.node.type)
}
} else {
UI.projects.education.spaces.docsSpace.openSpaceAreaAndNavigateTo(docs.project, docs.category, docs.type, docs.anchor, docs.nodeId, docs.placeholder)
}
}
break
@@ -0,0 +1,245 @@
{
"type": "Assets",
"name": "Superalgos Exchanges",
"config": "{\n\"folderPath\": \"\"\n}",
"project": "Governance",
"assetClasses": [
{
"type": "Asset Class",
"name": "SA Token Listings Rewards",
"config": "{\n\"folderPath\": \"\"\n}",
"project": "Governance",
"assetClasses": [
{
"type": "Asset Class",
"name": "CMC Top 10",
"config": "{\n\"folderPath\": \"\"\n}",
"project": "Governance",
"assetClasses": [],
"assets": [
{
"type": "Asset",
"name": "First Listing",
"config": "{}",
"project": "Governance",
"assetClasses": [],
"assets": [],
"id": "548dd163-9991-4de3-9e68-9e8a9a051a2f",
"savedPayload": {
"position": {
"x": 10018.264068711927,
"y": 38520.76406871193
},
"targetPosition": {
"x": 9806.132034355964,
"y": 38308.632034355964
},
"floatingObject": {
"isPinned": false,
"isFrozen": false,
"isCollapsed": false,
"angleToParent": 2,
"distanceToParent": 3,
"arrangementStyle": 0
},
"uiObject": {
"isRunning": false
}
}
}
],
"id": "7793964e-794b-4d76-b5fd-4ee67c3f3aab",
"savedPayload": {
"position": {
"x": 9806.132034355964,
"y": 38308.632034355964
},
"targetPosition": {
"x": 9594,
"y": 38096.5
},
"floatingObject": {
"isPinned": false,
"isFrozen": false,
"isCollapsed": false,
"angleToParent": 2,
"distanceToParent": 3,
"arrangementStyle": 0
},
"uiObject": {
"isRunning": false
}
}
},
{
"type": "Asset Class",
"name": "CMC Top 50",
"config": "{\n\"folderPath\": \"\"\n}",
"project": "Governance",
"assetClasses": [],
"assets": [
{
"type": "Asset",
"name": "Second Listing",
"config": "{}",
"project": "Governance",
"assetClasses": [],
"assets": [],
"id": "e4e7addb-a840-4ce9-9e01-74c7e57c24ad",
"savedPayload": {
"position": {
"x": 9594,
"y": 38696.5
},
"targetPosition": {
"x": 9594,
"y": 38396.5
},
"floatingObject": {
"isPinned": false,
"isFrozen": false,
"isCollapsed": false,
"angleToParent": 2,
"distanceToParent": 3,
"arrangementStyle": 0
},
"uiObject": {
"isRunning": false
}
}
}
],
"id": "ffec9d04-21ef-48eb-a29f-51d1e1c5cb59",
"savedPayload": {
"position": {
"x": 9594,
"y": 38396.5
},
"targetPosition": {
"x": 9594,
"y": 38096.5
},
"floatingObject": {
"isPinned": false,
"isFrozen": false,
"isCollapsed": false,
"angleToParent": 2,
"distanceToParent": 3,
"arrangementStyle": 0
},
"uiObject": {
"isRunning": false
}
}
},
{
"type": "Asset Class",
"name": "CMC Top 100",
"config": "{\n\"folderPath\": \"\"\n}",
"project": "Governance",
"assetClasses": [],
"assets": [
{
"type": "Asset",
"name": "Third Listing",
"config": "{}",
"project": "Governance",
"assetClasses": [],
"assets": [],
"id": "73c64b92-467f-4e27-8c3b-a624f00bbf53",
"savedPayload": {
"position": {
"x": 9169.735931288073,
"y": 38520.76406871193
},
"targetPosition": {
"x": 9381.867965644036,
"y": 38308.632034355964
},
"floatingObject": {
"isPinned": false,
"isFrozen": false,
"isCollapsed": false,
"angleToParent": 2,
"distanceToParent": 3,
"arrangementStyle": 0
},
"uiObject": {
"isRunning": false
}
}
}
],
"id": "6d69d279-c79d-4565-b8a2-5a612ef8b7b3",
"savedPayload": {
"position": {
"x": 9381.867965644036,
"y": 38308.632034355964
},
"targetPosition": {
"x": 9594,
"y": 38096.5
},
"floatingObject": {
"isPinned": false,
"isFrozen": false,
"isCollapsed": false,
"angleToParent": 2,
"distanceToParent": 3,
"arrangementStyle": 0
},
"uiObject": {
"isRunning": false
}
}
}
],
"assets": [],
"id": "492669d5-223f-426d-845a-f26dd1ae251e",
"savedPayload": {
"position": {
"x": 9594,
"y": 38096.5
},
"targetPosition": {
"x": 9594,
"y": 37796.5
},
"floatingObject": {
"isPinned": false,
"isFrozen": false,
"isCollapsed": false,
"angleToParent": 2,
"distanceToParent": 3,
"arrangementStyle": 0
},
"uiObject": {
"isRunning": false
}
}
}
],
"assets": [],
"id": "2cefeb95-9fde-418b-a35b-6178a97cac9d",
"savedPayload": {
"position": {
"x": 9594,
"y": 37796.5
},
"targetPosition": {
"x": 9594,
"y": 37796.5
},
"floatingObject": {
"isPinned": false,
"isFrozen": false,
"isCollapsed": false,
"angleToParent": 1,
"distanceToParent": 3,
"arrangementStyle": 0
},
"uiObject": {
"isRunning": false
}
}
}
File diff suppressed because it is too large. Load diff
+43 -287
View File
@@ -993,8 +993,8 @@
"id": "a987f1d3-fc8d-4b7c-99dd-77f15a32f37d",
"savedPayload": {
"position": {
"x": 25162.29870102263,
"y": 31076.943576746155
"x": 25137.213607224287,
"y": 31099.3609871306
},
"targetPosition": {
"x": 24950.166666666668,
@@ -1129,8 +1129,8 @@
"id": "797462ec-4b62-4fef-a7a7-134598715519",
"savedPayload": {
"position": {
"x": 24950.166666666668,
"y": 31164.81154239019
"x": 24883.410386479773,
"y": 31157.289916044738
},
"targetPosition": {
"x": 24950.166666666668,
@@ -1139,7 +1139,7 @@
"floatingObject": {
"isPinned": false,
"isFrozen": false,
"isCollapsed": false,
"isCollapsed": true,
"angleToParent": 1,
"distanceToParent": 3,
"arrangementStyle": 0
@@ -1166,12 +1166,12 @@
"id": "4d0ddf20-6ff5-4817-9ac1-17a247b50776",
"savedPayload": {
"position": {
"x": 24815.68034584146,
"y": 31366.721324632876
"x": 24657.456978220012,
"y": 31294.137803279813
},
"targetPosition": {
"x": 24738.034632310704,
"y": 31076.943576746155
"x": 24679.87600629594,
"y": 30994.976664125457
},
"floatingObject": {
"isPinned": false,
@@ -1201,12 +1201,12 @@
"id": "f6bdf0ec-e467-4d2f-aa9e-f4c2dd5eda50",
"savedPayload": {
"position": {
"x": 24660.388918779947,
"y": 31366.721324632876
"x": 24510.879988876855,
"y": 31242.848296420256
},
"targetPosition": {
"x": 24738.034632310704,
"y": 31076.943576746155
"x": 24679.87600629594,
"y": 30994.976664125457
},
"floatingObject": {
"isPinned": false,
@@ -1236,12 +1236,12 @@
"id": "e56590f0-e91f-4041-af03-e1219075f47f",
"savedPayload": {
"position": {
"x": 24525.90259795474,
"y": 31289.07561110212
"x": 24409.585345925214,
"y": 31125.141785860724
},
"targetPosition": {
"x": 24738.034632310704,
"y": 31076.943576746155
"x": 24679.87600629594,
"y": 30994.976664125457
},
"floatingObject": {
"isPinned": false,
@@ -1271,12 +1271,12 @@
"id": "df0b920e-bac5-4ac7-9954-45960f453556",
"savedPayload": {
"position": {
"x": 24448.256884423983,
"y": 31154.589290276912
"x": 24380.714867141585,
"y": 30972.55763604953
},
"targetPosition": {
"x": 24738.034632310704,
"y": 31076.943576746155
"x": 24679.87600629594,
"y": 30994.976664125457
},
"floatingObject": {
"isPinned": false,
@@ -1306,12 +1306,12 @@
"id": "ea3f169f-8fff-4501-ae75-c850158baff3",
"savedPayload": {
"position": {
"x": 24448.256884423983,
"y": 30999.297863215397
"x": 24432.004374001142,
"y": 30825.98064670637
},
"targetPosition": {
"x": 24738.034632310704,
"y": 31076.943576746155
"x": 24679.87600629594,
"y": 30994.976664125457
},
"floatingObject": {
"isPinned": false,
@@ -1335,8 +1335,8 @@
"id": "fe6ac3ba-f6db-4b71-858a-e594d6bbf314",
"savedPayload": {
"position": {
"x": 24738.034632310704,
"y": 31076.943576746155
"x": 24679.87600629594,
"y": 30994.976664125457
},
"targetPosition": {
"x": 24950.166666666668,
@@ -1345,7 +1345,7 @@
"floatingObject": {
"isPinned": false,
"isFrozen": false,
"isCollapsed": true,
"isCollapsed": false,
"angleToParent": 1,
"distanceToParent": 3,
"arrangementStyle": 0
@@ -1392,7 +1392,7 @@
},
"referenceParent": {
"type": "Assets",
"name": "Marketing",
"name": "Superalgos Marketing",
"id": "eeeed37c-a0e5-4d6c-a57f-01fdd8622f0f"
}
}
@@ -1427,7 +1427,7 @@
},
"referenceParent": {
"type": "Positions",
"name": "Marketing",
"name": "Superalgos Marketing",
"id": "19a3f688-75d8-4b27-a9b4-6ec9ceb3bcbf"
}
}
@@ -1436,252 +1436,8 @@
"id": "85dbdcb9-5b59-432e-86a0-fab37e20a55d",
"savedPayload": {
"position": {
"x": 24650.166666666668,
"y": 30864.81154239019
},
"targetPosition": {
"x": 24950.166666666668,
"y": 30864.81154239019
},
"floatingObject": {
"isPinned": false,
"isFrozen": false,
"isCollapsed": true,
"angleToParent": 1,
"distanceToParent": 3,
"arrangementStyle": 0
},
"uiObject": {
"isRunning": false
}
}
},
{
"type": "Pool Class",
"name": "Data Providers",
"config": "{}",
"project": "Governance",
"poolClasses": [
{
"type": "Pool Class",
"name": "Partnerships",
"config": "{}",
"project": "Governance",
"poolClasses": [
{
"type": "Pool Class",
"name": "Exchanges",
"config": "{}",
"project": "Governance",
"poolClasses": [],
"pools": [
{
"type": "Pool",
"name": "User Benefits",
"config": "{}",
"project": "Governance",
"poolClasses": [],
"pools": [],
"id": "5b93525d-63e5-4dee-b276-8a87c53669dc",
"savedPayload": {
"position": {
"x": 23946.3471021813,
"y": 30440.547473678263
},
"targetPosition": {
"x": 24236.12485006802,
"y": 30362.901760147506
},
"floatingObject": {
"isPinned": false,
"isFrozen": false,
"isCollapsed": false,
"angleToParent": 2,
"distanceToParent": 3,
"arrangementStyle": 0
},
"uiObject": {
"isRunning": false
}
}
},
{
"type": "Pool",
"name": "Promotion",
"config": "{}",
"project": "Governance",
"poolClasses": [],
"pools": [],
"id": "6d22af30-c333-4f82-b8de-2d744924844f",
"savedPayload": {
"position": {
"x": 24023.992815712056,
"y": 30150.769725791542
},
"targetPosition": {
"x": 24236.12485006802,
"y": 30362.901760147506
},
"floatingObject": {
"isPinned": false,
"isFrozen": false,
"isCollapsed": false,
"angleToParent": 2,
"distanceToParent": 3,
"arrangementStyle": 0
},
"uiObject": {
"isRunning": false
}
}
}
],
"id": "eacd4207-69aa-4475-8d5a-19a1cd4f58d8",
"savedPayload": {
"position": {
"x": 24236.12485006802,
"y": 30362.901760147506
},
"targetPosition": {
"x": 24525.90259795474,
"y": 30440.547473678263
},
"floatingObject": {
"isPinned": false,
"isFrozen": false,
"isCollapsed": false,
"angleToParent": 2,
"distanceToParent": 3,
"arrangementStyle": 0
},
"uiObject": {
"isRunning": false
}
}
},
{
"type": "Pool Class",
"name": "Data APIs",
"config": "{}",
"project": "Governance",
"poolClasses": [],
"pools": [
{
"type": "Pool",
"name": "User Benefits",
"config": "{}",
"project": "Governance",
"poolClasses": [],
"pools": [],
"id": "4083b97e-fdc4-43ec-bb40-c165d98290cc",
"savedPayload": {
"position": {
"x": 24236.12485006802,
"y": 29938.63769143558
},
"targetPosition": {
"x": 24448.256884423983,
"y": 30150.769725791542
},
"floatingObject": {
"isPinned": false,
"isFrozen": false,
"isCollapsed": false,
"angleToParent": 2,
"distanceToParent": 3,
"arrangementStyle": 0
},
"uiObject": {
"isRunning": false
}
}
},
{
"type": "Pool",
"name": "Promotion",
"config": "{}",
"project": "Governance",
"poolClasses": [],
"pools": [],
"id": "7fc28f21-fc73-49a7-925e-0609a9104b34",
"savedPayload": {
"position": {
"x": 24525.90259795474,
"y": 29860.99197790482
},
"targetPosition": {
"x": 24448.256884423983,
"y": 30150.769725791542
},
"floatingObject": {
"isPinned": false,
"isFrozen": false,
"isCollapsed": false,
"angleToParent": 2,
"distanceToParent": 3,
"arrangementStyle": 0
},
"uiObject": {
"isRunning": false
}
}
}
],
"id": "979bc0da-13bd-4d04-bdb9-264d3b69beb0",
"savedPayload": {
"position": {
"x": 24448.256884423983,
"y": 30150.769725791542
},
"targetPosition": {
"x": 24525.90259795474,
"y": 30440.547473678263
},
"floatingObject": {
"isPinned": false,
"isFrozen": false,
"isCollapsed": false,
"angleToParent": 2,
"distanceToParent": 3,
"arrangementStyle": 0
},
"uiObject": {
"isRunning": false
}
}
}
],
"pools": [],
"id": "eb9a0189-35ce-456b-ab7f-8eb62888215e",
"savedPayload": {
"position": {
"x": 24525.90259795474,
"y": 30440.547473678263
},
"targetPosition": {
"x": 24738.034632310704,
"y": 30652.679508034227
},
"floatingObject": {
"isPinned": false,
"isFrozen": false,
"isCollapsed": false,
"angleToParent": 2,
"distanceToParent": 3,
"arrangementStyle": 0
},
"uiObject": {
"isRunning": false
}
}
}
],
"pools": [],
"id": "32eb1f2e-d640-4c29-af0f-3d44e12e8206",
"savedPayload": {
"position": {
"x": 24738.034632310704,
"y": 30652.679508034227
"x": 24679.87600629594,
"y": 30734.646420654924
},
"targetPosition": {
"x": 24950.166666666668,
@@ -1717,12 +1473,12 @@
"id": "0ab4f6bc-0a31-4d10-bedc-8dc6e7ad104c",
"savedPayload": {
"position": {
"x": 24950.166666666668,
"y": 30264.81154239019
"x": 24816.654106292877,
"y": 30279.854795081097
},
"targetPosition": {
"x": 24950.166666666668,
"y": 30564.81154239019
"x": 24883.410386479773,
"y": 30572.333168735644
},
"floatingObject": {
"isPinned": false,
@@ -1737,7 +1493,7 @@
},
"referenceParent": {
"type": "Assets",
"name": "Exchanges",
"name": "Superalgos Exchanges",
"id": "2cefeb95-9fde-418b-a35b-6178a97cac9d"
}
}
@@ -1746,8 +1502,8 @@
"id": "b6d7a4fe-8990-47a2-a7ce-f5fd90384b53",
"savedPayload": {
"position": {
"x": 24950.166666666668,
"y": 30564.81154239019
"x": 24883.410386479773,
"y": 30572.333168735644
},
"targetPosition": {
"x": 24950.166666666668,
@@ -1809,7 +1565,7 @@
},
"referenceParent": {
"type": "Positions",
"name": "Foundations-Project",
"name": "Superalgos",
"id": "50c68665-5da2-48a8-b229-7a1563ae82d2"
}
}
@@ -1941,7 +1697,7 @@
},
"referenceParent": {
"type": "Features",
"name": "Foundations-Project",
"name": "Superalgos",
"id": "1d2c1985-c762-4ece-b350-15bd893bd1f4"
}
}
@@ -1975,8 +1731,8 @@
"id": "b27df32a-70f3-470b-b8bb-471c156b0c30",
"savedPayload": {
"position": {
"x": 25162.29870102263,
"y": 30652.679508034227
"x": 25137.213607224287,
"y": 30630.262097649782
},
"targetPosition": {
"x": 24950.166666666668,
@@ -756,7 +756,7 @@
},
"referenceParent": {
"type": "Feature Class",
"name": "Foundations Project",
"name": "Project Features",
"id": "136b6e7a-f042-441b-84be-395b56b65b70"
}
}
@@ -4188,7 +4188,7 @@
"featureWeightVotes": [
{
"type": "Feature Weight Vote",
"name": "",
"name": "Project Features Superalgos Mobile App Android Mobile App",
"config": "{}",
"project": "Governance",
"id": "f8256e48-52b8-4e95-b49e-1b3db503a0c2",
@@ -4221,7 +4221,7 @@
},
{
"type": "Feature Weight Vote",
"name": "",
"name": "Project Features Superalgos Mobile App iOS Mobile App",
"config": "{}",
"project": "Governance",
"id": "fa76f305-2fa0-4350-adb3-55c72146749f",
@@ -4254,7 +4254,7 @@
},
{
"type": "Feature Weight Vote",
"name": "",
"name": "Project Features Superalgos Mobile App Huawei Mobile App",
"config": "{}",
"project": "Governance",
"id": "9b6247c2-a078-43a5-853d-6f9d9b31f810",
@@ -4326,7 +4326,7 @@
"featureWeightVotes": [
{
"type": "Feature Weight Vote",
"name": "",
"name": "Project Features Superalgos P2P Network Node.js Implementation",
"config": "{}",
"project": "Governance",
"id": "8e3a31bc-3fab-4826-a18c-a040e9b17cae",
@@ -4415,7 +4415,7 @@
},
"referenceParent": {
"type": "Feature Class",
"name": "Foundations Project",
"name": "Project Features",
"id": "136b6e7a-f042-441b-84be-395b56b65b70"
}
}
@@ -4448,7 +4448,7 @@
},
"referenceParent": {
"type": "Features",
"name": "Foundations-Project",
"name": "Superalgos",
"id": "1d2c1985-c762-4ece-b350-15bd893bd1f4"
}
}
@@ -4477,7 +4477,7 @@
"positionWeightVotes": [
{
"type": "Position Weight Vote",
"name": "",
"name": "Community Management Moderator",
"config": "{}",
"project": "Governance",
"id": "fe6bbf7f-c838-428f-9e3f-99b6c9c7d779",
@@ -4549,7 +4549,7 @@
"positionWeightVotes": [
{
"type": "Position Weight Vote",
"name": "",
"name": "Business Business Lead",
"config": "{}",
"project": "Governance",
"id": "51309102-9d00-417f-9c6a-f928c1f3506c",
@@ -4582,7 +4582,7 @@
},
{
"type": "Position Weight Vote",
"name": "",
"name": "Business Advisor",
"config": "{}",
"project": "Governance",
"id": "80e3f058-9c35-426d-8468-435a4c257215",
@@ -4654,7 +4654,7 @@
"positionWeightVotes": [
{
"type": "Position Weight Vote",
"name": "",
"name": "Core Team Member",
"config": "{}",
"project": "Governance",
"id": "bf988832-e97d-46a7-92f1-67914cf08402",
@@ -4721,7 +4721,7 @@
"positionWeightVotes": [
{
"type": "Position Weight Vote",
"name": "",
"name": "Rewarded Positions Project Lead",
"config": "{}",
"project": "Governance",
"id": "98939a3f-34c2-4ab5-af61-36377b78d897",
@@ -4809,7 +4809,7 @@
},
"referenceParent": {
"type": "Positions",
"name": "Foundations-Project",
"name": "Superalgos",
"id": "50c68665-5da2-48a8-b229-7a1563ae82d2"
}
}
@@ -5221,7 +5221,7 @@
"assetWeightVotes": [
{
"type": "Asset Weight Vote",
"name": "",
"name": "All Blog Existing Blog Posts Blog Post",
"config": "{}",
"project": "Governance",
"id": "d9afded4-db56-4782-a5e9-ee7509b0db21",
@@ -5254,7 +5254,7 @@
},
{
"type": "Asset Weight Vote",
"name": "",
"name": "All Blog Existing Blog Posts Blog Post",
"config": "{}",
"project": "Governance",
"id": "ef6b969a-c4d3-4020-926a-3d2e93a7e7fc",
@@ -5326,7 +5326,7 @@
"assetWeightVotes": [
{
"type": "Asset Weight Vote",
"name": "",
"name": "All Blog Post Rewards How to install Superalgos and configure your Profile to get SA Tokens",
"config": "{}",
"project": "Governance",
"id": "fdd5c199-bc72-41e8-aec1-d9c7e158f508",
@@ -5449,7 +5449,7 @@
"assetWeightVotes": [
{
"type": "Asset Weight Vote",
"name": "",
"name": "Youtube Superalgos Channel Existing Videos Youtube Video",
"config": "{}",
"project": "Governance",
"id": "a6c9bf2b-e498-4880-b540-bc1eea489102",
@@ -5482,7 +5482,7 @@
},
{
"type": "Asset Weight Vote",
"name": "",
"name": "Youtube Superalgos Channel Existing Videos Youtube Video",
"config": "{}",
"project": "Governance",
"id": "eb723098-62d3-436d-965e-f47e7e1bb421",
@@ -5554,7 +5554,7 @@
"assetWeightVotes": [
{
"type": "Asset Weight Vote",
"name": "",
"name": "Youtube Superalgos Channel Videos Rewards How to install Superalgos and configure your Profile to get SA Tokens",
"config": "{}",
"project": "Governance",
"id": "cc3a38f6-17cc-47e4-b167-7b187bfb3b80",
@@ -5621,7 +5621,7 @@
"assetWeightVotes": [
{
"type": "Asset Weight Vote",
"name": "",
"name": "Youtube Superalgos Channel Existing Videos Youtube Video",
"config": "{}",
"project": "Governance",
"id": "9c2336bf-1d12-41b1-899d-072e74b313d1",
@@ -5654,7 +5654,7 @@
},
{
"type": "Asset Weight Vote",
"name": "",
"name": "Youtube Superalgos Channel Existing Videos Youtube Video",
"config": "{}",
"project": "Governance",
"id": "9d58ed72-bfa9-4fce-b081-c69041a09f70",
@@ -5913,7 +5913,7 @@
"assetWeightVotes": [
{
"type": "Asset Weight Vote",
"name": "",
"name": "Articles Crypto Media Coindesk First Article",
"config": "{\n \"percentage\": 60\n}",
"project": "Governance",
"id": "0e47a980-f159-412c-a566-66842ff45426",
@@ -5946,7 +5946,7 @@
},
{
"type": "Asset Weight Vote",
"name": "",
"name": "Articles Crypto Media Coindesk Second Article",
"config": "{\n \"percentage\": 30\n}",
"project": "Governance",
"id": "5cde8909-cf95-4e26-bb81-fd7025acaaed",
@@ -5979,7 +5979,7 @@
},
{
"type": "Asset Weight Vote",
"name": "",
"name": "Articles Crypto Media Coindesk Third Article",
"config": "{}",
"project": "Governance",
"id": "007c1202-f8c7-4e1a-b670-146a269d5084",
@@ -6051,7 +6051,7 @@
"assetWeightVotes": [
{
"type": "Asset Weight Vote",
"name": "",
"name": "Articles Crypto Media Coin Telegraph First Article",
"config": "{\n \"percentage\": 60\n}",
"project": "Governance",
"id": "9d23380e-01f8-4573-98dc-bed85217f3b0",
@@ -6084,7 +6084,7 @@
},
{
"type": "Asset Weight Vote",
"name": "",
"name": "Articles Crypto Media Coin Telegraph Second Article",
"config": "{\n \"percentage\": 30\n}",
"project": "Governance",
"id": "ede59373-2c3c-47dd-bb50-dc5d4caa6d38",
@@ -6117,7 +6117,7 @@
},
{
"type": "Asset Weight Vote",
"name": "",
"name": "Articles Crypto Media Coin Telegraph Third Article",
"config": "{}",
"project": "Governance",
"id": "9836d3a1-ba6f-4e38-8e1b-3e82fe5bb287",
@@ -6228,7 +6228,7 @@
"assetWeightVotes": [
{
"type": "Asset Weight Vote",
"name": "",
"name": "Articles Mainstream Media Forbes First Article",
"config": "{\n \"percentage\": 60\n}",
"project": "Governance",
"id": "ea4b6017-5450-4566-959f-ff6e70b73bc4",
@@ -6261,7 +6261,7 @@
},
{
"type": "Asset Weight Vote",
"name": "",
"name": "Articles Mainstream Media Forbes Second Article",
"config": "{\n \"percentage\": 30\n}",
"project": "Governance",
"id": "3ae891ad-5ef1-4ac2-9a70-98855c6dad67",
@@ -6294,7 +6294,7 @@
},
{
"type": "Asset Weight Vote",
"name": "",
"name": "Articles Mainstream Media Forbes Third Article",
"config": "{}",
"project": "Governance",
"id": "6c5d6ac6-7b22-45e3-a954-30861d9d4401",
@@ -6620,7 +6620,7 @@
"assetWeightVotes": [
{
"type": "Asset Weight Vote",
"name": "",
"name": "All Public Relations Crypto Media PR Campaign 6 Month PR Campaign",
"config": "{}",
"project": "Governance",
"id": "f20b20b0-26df-4c86-b693-5f2d7de36596",
@@ -6692,7 +6692,7 @@
"assetWeightVotes": [
{
"type": "Asset Weight Vote",
"name": "",
"name": "All Public Relations Trading Media PR Campaign 6 Month PR Campaign",
"config": "{}",
"project": "Governance",
"id": "ae51554a-e4f8-43e8-8cca-a3532713d4b5",
@@ -6815,7 +6815,7 @@
"assetWeightVotes": [
{
"type": "Asset Weight Vote",
"name": "",
"name": "Conferences Crypto or Trading Conferences Securing a Spot Labitconf",
"config": "{}",
"project": "Governance",
"id": "a0e7d36c-3360-4e54-8100-10125dd480ea",
@@ -6887,7 +6887,7 @@
"assetWeightVotes": [
{
"type": "Asset Weight Vote",
"name": "",
"name": "Conferences Crypto or Trading Conferences Speaking at Conference Labitconf",
"config": "{}",
"project": "Governance",
"id": "a25353e4-4abb-4064-ad07-71aebd5d7820",
@@ -6998,7 +6998,7 @@
"assetWeightVotes": [
{
"type": "Asset Weight Vote",
"name": "",
"name": "Conferences Unrelated Conferences Securing a Spot Monaco Streamming Conference 2021",
"config": "{}",
"project": "Governance",
"id": "3418ee65-6f70-4f3d-b198-1a50c279f16a",
@@ -7070,7 +7070,7 @@
"assetWeightVotes": [
{
"type": "Asset Weight Vote",
"name": "",
"name": "Conferences Unrelated Conferences Speaking at Conference Monaco Streamming Conference 2021",
"config": "{}",
"project": "Governance",
"id": "20f35cd4-6da6-47f5-9cd0-a65ed86d8f41",
@@ -7330,7 +7330,7 @@
},
"referenceParent": {
"type": "Assets",
"name": "Marketing",
"name": "Superalgos Marketing",
"id": "eeeed37c-a0e5-4d6c-a57f-01fdd8622f0f"
}
}
@@ -7353,7 +7353,7 @@
"positionWeightVotes": [
{
"type": "Position Weight Vote",
"name": "",
"name": "Rewarded Positions Marketing Lead",
"config": "{}",
"project": "Governance",
"id": "95ec9f89-0c77-4136-8670-146699ac67a2",
@@ -7386,7 +7386,7 @@
},
{
"type": "Position Weight Vote",
"name": "",
"name": "Rewarded Positions Advisor",
"config": "{}",
"project": "Governance",
"id": "5c4f1655-8f2f-46fc-9016-52248fe725d3",
@@ -7474,7 +7474,7 @@
},
"referenceParent": {
"type": "Positions",
"name": "Marketing",
"name": "Superalgos Marketing",
"id": "19a3f688-75d8-4b27-a9b4-6ec9ceb3bcbf"
}
}
@@ -7529,7 +7529,7 @@
"assetWeightVotes": [
{
"type": "Asset Weight Vote",
"name": "",
"name": "Superalgos Exchanges SA Token Listings Rewards CMC Top 10 First Listing",
"config": "{}",
"project": "Governance",
"id": "af09a15d-8328-4339-937e-18fab88321d3",
@@ -7601,7 +7601,7 @@
"assetWeightVotes": [
{
"type": "Asset Weight Vote",
"name": "",
"name": "Superalgos Exchanges SA Token Listings Rewards CMC Top 50 Second Listing",
"config": "{}",
"project": "Governance",
"id": "fcc95efc-0523-40f6-bae6-a1860824b961",
@@ -7673,7 +7673,7 @@
"assetWeightVotes": [
{
"type": "Asset Weight Vote",
"name": "",
"name": "Superalgos Exchanges SA Token Listings Rewards CMC Top 100 Third Listing",
"config": "{}",
"project": "Governance",
"id": "9ad43160-b86e-4b87-acc8-140c043b1970",
@@ -7796,7 +7796,7 @@
},
"referenceParent": {
"type": "Assets",
"name": "Exchanges",
"name": "Superalgos Exchanges",
"id": "2cefeb95-9fde-418b-a35b-6178a97cac9d"
}
}
@@ -7880,7 +7880,7 @@
"assetWeightVotes": [
{
"type": "Asset Weight Vote",
"name": "Foundations-Project Plugins API-Data-Mines Rewards Plugins Rewards Data-Mines API-Data-Mines wit Indicators, Plotters and Sample Workspace with Trading-System",
"name": "",
"config": "{}",
"project": "Governance",
"id": "442848b4-f164-43cb-b56c-57e4997c085c",
@@ -8030,7 +8030,7 @@
"assetWeightVotes": [
{
"type": "Asset Weight Vote",
"name": "Foundations-Project Plugins Data-Mines Rewards Plugins Rewards Data-Mines Data Mines wit Indicators, Plotters and Sample Workspace with Trading-System ",
"name": "",
"config": "{}",
"project": "Governance",
"id": "a9d80714-a6f1-43b2-a277-921b4f7e61be",
@@ -8180,7 +8180,7 @@
"assetWeightVotes": [
{
"type": "Asset Weight Vote",
"name": "Foundations-Project Plugins Trading-Systems Rewards Plugins Rewards Trading-Systems Elaborated Plug & Play Trading System",
"name": "",
"config": "{}",
"project": "Governance",
"id": "a62fc533-f051-4d29-b6a2-52acf5c473cb",
+97 -374
View File
@@ -15,373 +15,95 @@ Superalgos is the ultimate market research and trading automation platform. The
# Getting Started Guide
All procedures are the same for Windows, Linux, or Mac OS. Raspberry Pi terminal commands have been included for ease of use.
> **IMPORTANT:** Remote installations and minimalist hardware —both virtual and physical— are better suited for production deployments, where the use of the GUI is minimal. We highly recommend learning Superalgos in a local installation. Mastering the system takes time, and the use of the GUI to go through in-app tutorials is crucial during the learning process. Your experience will be orders of magnitude better if you follow this advice: leave remote installations and minimalist hardware for when you are ready to start trading live.
# Pre-Requisites
## 1. Node JS Installation
If you don't have it yet, download and install Node.js.
Node JS is an open-source server environment required to run Superalgos.
**A.** Go to the Node JS [download page](https://nodejs.org/en/download/).
**B.** Download your system’s installer. Select *LTS Recommended for Most Users* and click the big Windows or macOS Installer button. If you are on Linux, the installer is listed further down the page.
**C.** Run the installer with the default configuration — just click Next until Node.JS is fully installed. That's it! You can continue with step 2 (Git Installation).
<hr>
**NODE JS INSTALLATION FOR RASPBERRY PI USERS**
You may install Node.JS just like you would on any other machine as per the above instructions. As an alternative, you may also try the following from the SSH Terminal.
**NOTE:** It is best to use the most current and updated version of the FULL PiOS image.
```
curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
```
Followed by:
```
sudo apt-get install -y nodejs
```
It is also required to install the Node Package Manager for dependancy management.
```
sudo apt install npm
```
You may also type the following to verify Node.js and NPM installation and version.
```
node -v
```
```
npm -v
```
<hr>
## 2. Git Installation
Download and install Git.
Git is an open-source distributed version control system required to download and stay up to date with Superalgos.
**A.** Go to the Git [download page](https://git-scm.com/downloads).
**B.** Download the version for your Operating System.
**C.** Run the installer with the default configuration — just click Next until Git is fully installed.
**IMPORTANT:** The latest version of Git is required to handle the authentication with GitHub.com.
**NOTE FOR MAC USERS:** Depending on your setup, installing Git may be optional. The native XCode Command Line Developer Tools seems to work well. If you do install Git, we have tested Tim Harper's binary installer successfully.
<hr>
**GIT INSTALLATION FOR RASPBERRY PI USERS**
Just like with Node.JS, you may follow the above instructions to install Git, or use the SSH Terminal command. The most recent version of PiOS has Git already installed, so this may give you an error. The error will not affect your installation.
```
sudo apt-get install git
```
<hr>
## 3. Google Chrome or Safari
Use Chrome, or Safari on Mac. These are the only tested browsers.
**A.** Go to the Chrome [download page](https://www.google.com/chrome/).
**B.** Run the installer.
Before you begin, it is recommended that you set up Chrome/Safari as your default browser.
**IMPORTANT:** Use Chrome/Safari so that you have a similar environment as the dev team in case you need help. We are not testing on any other browsers, and it is a well-known fact that browsers behave differently.
# Superalgos Client Installation
## 1. Fork the Superalgos Repository
**A.** Scroll the page all the way to the top. Find and click the **Fork** button to create your fork/copy of this repository. To fork Superalgos you need a Github account. If you don't have one, go ahead and create it.
**NOTE:** A Fork is required for your contributions to the project. The reason why Superalgos is free and open-source is that the project has set up a <a href="https://superalgos.org/community-business.shtml" target="_blank">Collective Business</a> in which all users may participate. The way to participate is to <a href="https://superalgos.org/community-contribute.shtml" target="_blank">contribute</a> to make Superalgos better. The project's <a href="https://superalgos.org/token-overview.shtml" target="_blank">token</a> is distributed among contributors.
## 2. Clone Your Fork
**A.** Once the fork is created, you will land on the page of your fork. Copy the URL from your browser's address bar.
**B.** In your computer/laptop/server, open a command prompt or terminal. Make sure you are in a directory where you have write permissions (on most systems the terminal will open in your user’s home directory, so you’re good). Clone the git repository using the command:
```
git clone <URL of your Superalgos fork>
```
For example, if your Github username is John, the command will look like this:
```
git clone https://github.com/John/Superalgos
```
This creates the `Superalgos` folder in the current directory, which contains the whole installation.
## 3. Install Node Dependencies
**A.** After the Superalgos directory has been installed, the final step of installation is to set up the necessary node dependencies.
**B.** In the same command prompt or terminal you just used, type the following command:
```
node setup
```
Then wait until you are able to type within the terminal again.
This command will install and configure all additional dependencies needed by Superalgos. It will also install desktop and start menu shortcuts.
**NOTE FOR USERS INSTALLING MULTIPLE INSTANCES OF SUPERALGOS ON THE SAME MACHINE:** In order to avoid name conflicts between shortcuts, make sure to rename each Superalgos directory before running `node setup`.
Congratulations your installation is complete!
> **The Usage section below explains how to run the app.**
<hr>
**DEPENDENCY INSTALLATION FOR RASPBERRY PI USERS**
As noted above, running `node setup` installs GUI shortcuts by default. To suppress this behavior in headless installations, add the `noShortcuts` flag as follows:
```
node setup noShortcuts
```
<hr>
**Troubleshooting Dependency Installation**
If you are having difficulty running the node setup command here are a few common issues that may be getting in the way.
**1.** Check the version of node and npm you have installed. Make sure that you are running an updated version of node greater than version 12 and npm greater than version 5. You can check which version you have by typing `node -v` and `npm -v` into a command prompt or terminal. If your version numbers are below these, you can update your installation by following the instructions outlined in the "Node JS Installation" step above.
**2.** If you are installing Superalgos in an administratively protected directory you will need to do one of the following:
- For Windows start your command prompt as an administrator.
- For Linux and Mac Systems make sure to add the sudo command to node setup. This will look like `sudo node setup`.
**3.** For Windows it is important that you have C:\Windows\System32 added to your global PATH. For instructions on how to do this google "add to the path on Windows 10."
<hr>
## 4. Installation Notes
**A.** You need to make a fork so that you may contribute work. Superalgos is a Community project and you are expected to contribute, like everyone else. You don't need to be a technical person to contribute. Fixing a typo in the docs or translating a paragraph into your native language are valuable contributions too. Superalgos has built-in features that make contributing easy. Help make Superalgos better and Superalgos will better serve you! [Free-riding is not cool](https://en.wikipedia.org/wiki/Free-rider_problem), particularly on free, open-source, Community-driven projects.
**B.** The software includes an in-app self-update command / feature. It will help you stay up-to-date with the latest version of the software. Updates are on-demand, so don't worry about undesired updates. The project moves very fast and new features become available regularly, particularly if you choose to run the software in the ```develop``` branch (you may switch branches from within the app).
**C.** It is a good idea to perodically run the `node setup` command to keep the underlying dependencies for your Superalgos installation up to date.
**D.** Before installing the client on a remote computer in an attempt to access the UI from a different machine, we highly recommend you do a standard installation on your PC / laptop first. Leave your Raspberry Pi or VPS for later, once you have done all available tutorials. This single tip will save you a lot of time: you don't need to add complexity before you learn how to handle the app, and the GUI performs best in a local installation.
# Usage
## 1. Run the Client and GUI
**A.** To run Superalgos, go to the Superalgos directory/folder and run this command:
```
node run
```
The Client will run on your terminal and the GUI will launch on your default browser. If Chrome/Safari is not your default browser, copy the URL, close the browser, open Chrome/Safari, and paste the URL. Be patient... it takes a few seconds to fully load the GUI.
A Welcome Tutorial pops-up automatically. You must do this Tutorial to finish the setup and to learn the basics. It's the ultimate onboarding experience, superior to all other resources available, including videos and the Docs.
![run-the-system-01](https://user-images.githubusercontent.com/13994516/107037804-e5fc6200-67bb-11eb-82f2-d0f40247fa14.gif)
If you are running a headless Raspberry Pi (one without a screen) you may need to change directories first and run Superalgos with the `minMemo` and `noBrowser` options.
```
cd Superalgos
```
then
```
node run minMemo noBrowser
```
In addition, you may use any of the automatically installed desktop and start menu shortcuts to launch Superalgos.
**NOTE:** Shortcuts are not currently supported on Mac. Collaborators are needed to finish this feature.
**B.** Enable Desktop Shortcut on Ubuntu
The majority of shortcuts that are automatically installed will work out of the box. Desktop shortcuts on Ubuntu, however, require a few additional steps to set up.
First, desktop icons need to be enabled within the Tweaks app.
* Check if Tweaks is installed.
* If not go to Ubuntu Software.
* Install Tweaks.
* Open Tweaks.
* Under extensions turn on Desktop Icons
![enable-ubuntu-shortcut](https://user-images.githubusercontent.com/55707292/117553927-f0780300-b019-11eb-9e36-46b509653283.gif)
**TIP:** If you do not see the desktop shortcut appear right away you may need to restart your computer.
Finally, you will need to enable the desktop shortcut.
* Right click Superalgos.desktop and select Allow Launching.
![allow-launching](https://user-images.githubusercontent.com/55707292/117553933-fcfc5b80-b019-11eb-872c-4fad81b184d2.gif)
Now both launcher and desktop shortcuts will launch Superalgos like any other program on your computer.
## 3. Usage Notes
We are testing the UI on Google Chrome and Safari on macOS only. It may work on other browsers as well &mdash; or not. If you are running on a different browser and ever need support, make sure you mention that fact upfront, or even better, try on Chrome/Safari first.
**TIP:** If your computer has 8 GB of RAM or less, use ```node run minMemo``` to run the system with minimal RAM requirements.
# Running Superalgos on a Headless Linux Server as a Daemon
If you’re running Superalgos on a headless linux server like a Raspberry Pi, you might want to run it as a daemon so it isn’t attached to your current login session. The easiest, most standard way to go about this is probably using `systemd`. Most linux distributions use it as default init system/service manager.
## Using `systemd`
Create a `superalgos.service` file looking like this (change `<user>` to your user name and `/path/to/Superalgos` to your Superalgos folder, for instance `/home/John/Superalgos`):
```
[Unit]
Description=Superalgos client
[Service]
Type=simple
User=<user>
WorkingDirectory=/path/to/Superalgos
ExecStart=/usr/bin/node run minMemo noBrowser
[Install]
WantedBy=multi-user.target
```
There is no need to run Superalgos as root so we’re running it as a user. The `minMemo` option assumes you’re running on a small machine like a Raspberry Pi, while `noBrowser` makes sense for running daemonized.
Now, as root (or using `sudo`), put the file `superalgos.service` you just created in `/etc/systemd/system/` and issue the command
```
systemctl enable superalgos
```
This will install the service so that Superalgos is started on boot. To start it manually, do (again as root or with `sudo`)
```
systemctl start superalgos
```
To see the output of Superalgos, use
```
journalctl -u superalgos
```
or to follow the output,
```
journalctl -u superalgos -f
```
# Uninstall
Superalgos writes nothing outside of the ```Superalgos``` folder other than shortcut files. To uninstall the software, follow these steps:
Open a terminal or command prompt and navigate to your main Superalgos directory and type the following command:
```
node uninstall
```
This will remove any shortcut files that have been installed.
Then simply delete the `Superalgos` folder. There will be nothing left on your computor.
# Welcome Tutorial
Once the app finishes loading, an interactive tutorial takes you by the hand and walks you all around the system while you learn the basic skills required to use the interface, mine data, backtest strategies, and even run a live trading session. It is highly recommended you follow the tutorial until the end, as it is carefully crafted to make your onboarding as easy as possible. Tutorials are the absolute best way to tackle the learning curve. You should do all tutorials before you start exploring other avenues on your own.
![welcome-tutorial-00](https://user-images.githubusercontent.com/13994516/107038771-4a6bf100-67bd-11eb-92e0-353525a972a9.gif)
**NOTE:** The tutorial uses Binance or Binance US as the exchange of choice. If you don’t have an account with Binance or Binance US, you will still be able to follow 100% of the tutorial. When you get to the live trading section, keep going even if you don't intend to run the session. You may learn how to work with other exchanges later on.
# Docker Deployments
Docker container images can be found at https://github.com/users/Superalgos/packages/container/package/superalgos
If you wish to run Superalgos over docker platform, follow these steps.
**Note:** This has not been extensively tested yet. If you run into troubles, please contact us at the [Superalgos Support Group](https://t.me/superalgossupport).
## 1. Install Docker
Follow the link to [install docker](https://docs.docker.com/engine/install/).
## 2. Run
### Option A. Using pre-built container
You will need to create local storage directories beforehand, by example with `mkdir Data-Storage Log-Files My-Workspaces`
```
docker run \
-d \
--rm \
--name superalgos \
-p 18041:18041 \
-p 34248:34248 \
-v $(pwd)/Data-Storage:/app/Data-Storage \
-v $(pwd)/Log-Files:/app/Log-Files \
-v $(pwd)/My-Workspaces:/app/My-Workspaces \
ghcr.io/superalgos/superalgos:latest
```
Now you can access the Superalgos UI at http://127.0.0.1:34248
To see console logs you can use `docker logs superalgos -f`
When you're done just exec `docker kill superalgos`
### Option B. Build container locally using docker-compose
Follow the link to [install docker-compose](https://docs.docker.com/compose/install/)
Run `docker-compose -f Docker/docker-compose.yml up`.
## Configure the Container Environment
### Available image tags
To avoid breaking changes, the `shasum hash` and the `release` tags are the best to use. These will generally ensure you are always running the same code. The other tags will change which code they are pointing to more frequently and without notice.
- `latest` : the absolute latest build
- `master` : the latest master branch build
- `develop` : the latest develop branch build
- `<shasum hash>` : a specific git commit hash
- `<release>` : corresponds with a Github Release (git tag), i.e. `beta-10`
### Environment variables
`PUID` and `GUID` environment variables can be used to help avoid permissions issues in the mounted volumes between the container environment and the local OS environment. The default `PUID` and `GUID` is `1000`. You can view the current user's PUID and GUID with the `id` command.
Follow the link to the [INSTALL] file. (https://github.com/Superalgos/Superalgos/blob/develop/INSTALL.md).
# What is Superalgos?
Superalgos is a platform to automate crypto-trading. It is implemented as a Node JS Client + Web App that runs on your hardware and scales from a single Raspberry Pi to a Trading Farm. Superalgos is **Free** and **Open-Source**.
**Superalgos is a token-incentivized open-source project.**
## Superalgos Features
The project incentivizes users to continuously improve Superalgos. Users contribute to the codebase, to the library of trading intelligence, and to project development in general -- and earn SA tokens for their contributions. Providing free, high-quality, real-time trading-intelligence over the Superalgos peer-to-peer network is a key activity, also incentivized.
**Superalgos is an open-network project built on top of the Internet + Bitcoin + Lighting open networks.**
This means that the Superalgos open network target audience is 8 billion people and that payments of products and services offered through the Superalgos Network are done with bitcoin over the Lighting Network.
**Superalgos is a free and open trading-intelligence network anyone can plug-in to emit or consume real-time trading signals.**
Signals are cryptographically signed by trading intelligence producers and backed by their token holdings and reputation. The Superalgos p2p Network sorts how signals are distributed, prioritizing signals-consumers with the biggest token holdings.
**Superalgos has the ultimate scalable and defensible business model.**
* Everything is free and open source for its user base: trading automation tools + mobile apps for consuming real-time trading intelligence.
* The Superalgos algo-traders community members compete with each other to mine SA tokens by producing high quality real-time trading intelligence which is consumed for free by the Superalgos user base to automate their trading.
* Trading Intelligence is distributed via a protocol-incentivized p2p network with no network fees.
* The long term viability is guaranteed since the business model can not be disrupted.
**Superalgos massive adoption is highly likely since all friction has been removed.**
* Users don’t need to pay for the mobile app to consume trading intelligence.
* Users don’t need to pay for high-quality trading intelligence.
* Algo-traders don’t need to pay for the tools to produce trading intelligence.
* Real-time trading Intelligence does not need to be bought or sold. The Superalgos Project buys real-time trading intelligence (via minting new tokens) from the algo-traders community and distributes it for free to all the user base via its p2p network.
* The Superalgos SA token does not need to be spent to be used, avoiding the need to pay blockchain fees. Only it’s balance is relevant to backup the user profile’s reputation and skin on the game, and in the case of real-time trading intelligence consumers give them priority access to signals.
**Holding the SA Token is the open network business model for all participants.**
* Tokens should appreciate in value as the network effects and game theory embedded in the system design kicks in over time.
* Buying pressure will come from users competing to be among the first to receive the trading-signals.
* Buying pressure will also come from algo-traders competing to be at the top of the list of real-time trading intelligence providers.
* Algo trades make money, users make money, the token appreciates, everyone wins.
**Superalgos will become one of the most powerful consumer brands on the planet because:**
* We are building a brand that is inline and incentivized with our users.
* We have the business acumen and profile of a token-incentivized-open source project.
* The project acts as an union, collecting benefits for its user base, like better exchange fees for all.
* We don’t collect or sell user data.
* We don’t sell ads to anyone.
* We don’t collect or sell users trading information that can be used to front run them.
* We know how we are going to make money, and it is on token appreciation.
* Founders and team are just token holders as any other contributors.
**Superalgos Mobile Apps will have the best user experience possible:**
* The best user experience means users should be able to consume top quality, free real-time trading intelligence and autonomously execute trades while they are sleeping.
* Users just need to select their exchange, provide an exchange access token, define their base asset, amount of funds to be traded and trading intelligence providers.
* Their mobile phone will become a 24/7 trading bot plugged into the Superalgos Network to receive trading signals and firing trading orders at any exchange.
* Similar to a bitcoin wallet, anyone will be able to develop Superalgos Mobile Apps for consuming trading-signals. This open competition will be a race to the best UX possible.
* Established crypto wallets or any trading app in general, can plugin into the Superalgos Network and consume real-time trading intelligence for free.
**Superalgos does not sell it’s tokens to anyone for any reason.**
SA Tokens are distributed after each software release among the contributors of that release. If you want to mine SA tokens you can start contributing yourself or hire / sponsor someone (usually a developer or trader) to do it on your behalf.
# Which is the Superalgos Software Architecture?
Superalgos features these 3 main components:
1. Superalgos Platform: An already functional set of tools designed for algor-traders for automating their own trading and producing trading-signals.
2. Superalgos Mobile: An under-development mobile app reference implementation for cosuming real-time trading intelligence and automate users trading.
3. Superalgos Network: An under-development open p2p network for distributing real-time trading intelligence between producers (algo-traders) and consumers (the project's user base).
All of the above is / will be hosted in this repository.
# What is Superalgos Platform?
Superalgos Platform is a platform to automate crypto-trading. It is implemented as a Node JS Client + Web App that runs on your hardware and scales from a single Raspberry Pi to a Trading Farm.
## Superalgos Platform Features
* A Visual Scripting Designer.
* Integrated Charting System.
* A Visual Strategy Debugger.
* Data Mining Tools.
* Coordinated Task Management across a Trading Farm.
* Community-built strategies to learn and start from.
* TensorFlow Machine Learning integration.
* In-App Tutorials.
* Complete In-App Documentation.
* SA Token / Project Governance System.
## Superalgos Allows You To...
## Superalgos Platform Allows You To...
* Visually design your trading strategies.
* Visually debug your trading strategies.
@@ -393,29 +115,22 @@ Superalgos is a platform to automate crypto-trading. It is implemented as a Node
* Run live trading sessions.
* Run arbitrary data-mining operations of any size.
* Feed your trading strategies with the data mined.
* Produce real-time trading signals and send them via the p2p network. (under development)
## Superalgos Development Pipeline
## Superalgos Platform Development Pipeline
* Ethereum Integration: will allow you to data mine your own Ethereum node and use the mined data in your strategies.
* **Superalgos P2P Network:** will allow algo-traders to share trading signals with Superalgos users consuming these signals via a mobile app.
* **Real-time Trading Signals:** will allow users to emit trading signals and be rewarded with SA Tokens.
* **Superalgos Mobile:** Will allow users to consume trading signals for free and autonomously execute trades from their mobile phones.
* **Ethereum Integration:** Will allow mining data from an Ethereum network node, and bring it into the Superalgos workflow.
* Machine Learning: will allow you to run a Reinforcement Learning Algorithm and feed it with mined data for it to learn how to make decisions relevant to your strategies.
# Superalgos Platform for Developers
## Superalgos is User-centric
* No ads, anywhere.
* No sign up / logins.
* No user/usage data collection of any kind.
* Runs 100% on uncompiled code anyone can read and audit.
# Superalgos for Developers
* You are free to customize Superalgos for your customers. No royalties, no license fees.
* Everything extra your customers may need may be coded by yourself or requested as new features.
* You may use Superalgos as a platform or as a component of a larger system.
* No proprietary code/libraries. All open-source and free.
* Superalgos features a library of community-contributed plugins (workspaces, strategies, indicators, plotters, tutorials, etc.).
## Superalgos Saves You Time
## Superalgos Platform Saves You Time
* No need to code the download of historical data from crypto exchanges.
* No need to code the streaming of market data from crypto exchanges.
@@ -424,7 +139,15 @@ Superalgos is a platform to automate crypto-trading. It is implemented as a Node
* No need to integrate a charting library, Superalgos features an integrated Charting System.
* No need to manage task data or execution dependencies. Superalgos allows you to define Tasks and distribute them across a Trading Farm and takes care of the data and execution dependencies so that each task automatically starts when their dependencies are ready.
## Superalgos is Permissionless
## Superalgos Platform is User-centric
* No ads, anywhere.
* No sign up / logins.
* No user/usage data collection of any kind.
* No user trading information collected or sold.
* Can runs 100% on uncompiled code anyone can read and audit.
## Superalgos Platform is Permissionless
* Don't like the UI?
* Don't like the icons used?
@@ -439,7 +162,7 @@ Superalgos is a platform to automate crypto-trading. It is implemented as a Node
No problem, code or integrate libraries with your own version of any component and we promise we will merge your work and provide it as an alternative to users. We believe in Permissionless Innovation and that users, not team members, are the final judges and the ones who decide what they prefer to use. You are free to create an alternative for any part of the system that you believe that should work or should have been done in a different way. We will help you integrate your vision into the next release and enable a way for users to choose between different implementations of the same functionality. You will also be granted the title of maintainer of the functionality you provide and have decision power on how it evolves in the future.
# Superalgos for Individuals
# Superalgos Platform for Algo-Trders
* Superalgos is easy to install/uninstall.
* Superalgos is easy to run.
@@ -449,7 +172,7 @@ No problem, code or integrate libraries with your own version of any component a
* Superalgos is well documented.
* You have free online support via Telegram and Discord.
## Superalgos Saves You Money
## Superalgos Platform Saves You Money
* There are no paid plans or anything that costs you money.
* There is no locked functionality. You may use the full capacity of the software.
@@ -462,7 +185,7 @@ No problem, code or integrate libraries with your own version of any component a
* Your installations may be used by as many people as required.
* You may connect to as many crypto exchanges as you wish.
## Superalgos Minimizes Risks
## Superalgos Platform Minimizes Risks
* No one can know what strategies you design/run.
* No one can front-run you.
@@ -470,7 +193,7 @@ No problem, code or integrate libraries with your own version of any component a
* No one knows how much capital you trade.
* No one can see your exchange keys.
# Superalgos for Companies
# Superalgos Platform for Companies
* No need to buy expensive software for monitoring crypto markets or trading execution.
* All your employees can use Superalgos for free.