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

Merge pull request #760 from Superalgos/develop

Browse Source 
Beta 9 RC 2
This commit is contained in:
Luis Fernando Molina authored and GitHub committed 2021-04-02 07:30:15 -04:00
2 parents 4a14976d81 50c255fb26
commit 571ceb61d4
10 files changed
+175 -69
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

Client/WebServer/Images/Languages/TR.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 12 KiB

Client/WebServer/index.html
+1 -7
View File
@@ -57,13 +57,7 @@
<div id="contributors" class="credits">
<p id="credits-page-status-paragraph" class="credits-yellow">The UI is loading...</p>
<p>Superalgos is <span class="credits-red">open source</span>, <span class="credits-red">forever free</span> for <span class="credits-red">everyone</span>, and is <span class="credits-red">constantly improving</span> thanks to the involvement of contributors:</p>
<p>Luis Fernando Molina, Julian Molina, Andreja Cobeljic, Matías Benitez, Ira Miller, Eduardo Remis,
Jeff Braun, rico4dev, 9808us, Barry Low, Nikola Bjelogrlic, Hirajin Koizuko, Francisco J. Santillán, Norman,
Viktoria B., Guillermo V., Carl J, Daniel J.,
Javier A., Gustavo J., Romina GS, Pedro P., Thais M., Andrey M., Loui M., Natalia M., Bashar A., Carlos V.,
Diego M., CarnivalBen,
Sebastian E., Bogdan P., Marko V., Igor S., Niksa K., Rodrigo M., Nicanor M., Alejandro P., Mateo H., Lan
T., Leon A., Uroš R., Filip M., Vladimir J. and Pavle B.</p>
<p>Luis Fernando Molina, Julian Molina, Andreja Cobeljic, Ira Miller, matbenitez, bearcanrun, nikolabjelo, 9808us, pmmax, suttridge, Basalt09, Mhnramin, 0xperez, infin1t3, benitezme, whtv, cozed-gh, Eduardo678-dotcom, Smidy13, teehanming, 64bittuning, joenij, apronotti, Noeljarillo, ssplatt, rico4dev, DougJCook, mane, Cordo-van-Saviour, CarnivalBen, Sil3ntLight, pisukesoramame, Edodi, harrellbm, CaptainJeff, Jeff Braun, Francisco J. Santillán, Norman, Viktoria B., Guillermo V., Daniel J., Javier A., Gustavo J., Romina GS, Pedro P., Thais M., Andrey M., Loui M., Natalia M., Bashar A., Carlos V., Diego M., Sebastian E., Bogdan P., Marko V., Igor S., Niksa K., Rodrigo M., Nicanor M., Mateo H., Lan T., Leon A., Uroš R., Filip M., Vladimir J. and Pavle B.</p>
<p>Please, <span class="credits-red">give a star to the Superalgos repo at GitHub.com...</span> It helps other devs find the project!</p>
</div>
<div id="masterApp"></div>
Projects/Superalgos/Icons-SVG-Sources/flags/TR.svg
+37
View File
@@ -0,0 +1,37 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 19.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
viewBox="-703 270 512 512" style="enable-background:new -703 270 512 512;" xml:space="preserve">
<style type="text/css">
.st0{display:none;}
.st1{clip-path:url(#SVGID_2_);}
.st2{fill:#E30A17;}
.st3{fill:#FFFFFF;}
</style>
<polygon class="st0" points="557.7,-304 299,-304 299,208 811,208 811,44.1 557.7,44.1 "/>
<rect x="557.7" y="-304" class="st0" width="253.3" height="348.1"/>
<g class="st0">
<text transform="matrix(1 0 0 1 335.4224 -173.0488)" style="display:inline;fill:#CDD4D5; font-family:'Saira-Black'; font-size:64.1866px;">E = mc</text>
<text transform="matrix(1 0 0 1 528.1074 -194.4227)" style="display:inline;fill:#CDD4D5; font-family:'Saira-Black'; font-size:37.4208px;">2</text>
</g>
<g>
<defs>
<circle id="SVGID_1_" cx="-447" cy="526" r="256"/>
</defs>
<clipPath id="SVGID_2_">
<use xlink:href="#SVGID_1_" style="overflow:visible;"/>
</clipPath>
<g id="XMLID_11_" class="st1">
<rect id="XMLID_22_" x="-744.6" y="270" class="st2" width="768" height="512"/>
<g id="XMLID_12_">
<polygon id="XMLID_14_" class="st3" points="-281.9,489.9 -324.3,503.7 -350.6,467.6 -350.6,512.2 -393,526 -350.6,539.8
-350.6,584.4 -324.3,548.3 -281.9,562.1 -308.1,526 "/>
<path id="XMLID_13_" class="st3" d="M-458.5,624.3c-54.3,0-98.3-44-98.3-98.3c0-54.3,44-98.3,98.3-98.3
c29.1,0,55.2,12.6,73.2,32.7c-21.8-34.4-60.2-57.3-103.9-57.3c-67.9,0-122.9,55-122.9,122.9s55,122.9,122.9,122.9
c43.7,0,82.1-22.9,103.9-57.3C-403.4,611.7-429.5,624.3-458.5,624.3z"/>
</g>
</g>
</g>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 1.7 KiB

Projects/Superalgos/Icons/Thumbs.db
BIN
View File
Binary file not shown.
Projects/Superalgos/Schemas/Docs-Topics/docs-languages-007-docs-in-turkish.json
+39
View File
@@ -0,0 +1,39 @@
{
"topic": "Docs Languages",
"pageNumber": "7",
"type": "Docs In Turkish",
"definition": {
"text": "The Docs pages of Superalgos and other projects integrated are originally written in English. The system allows users to search and browse pages in other languages as well, as long as users have previously contributed the corresponding translations.",
"updated": 1613820592771,
"translations": [
]
},
"paragraphs": [
{
"style": "Text",
"text": "English is considered the default language. When you switch to a different language, the system attempts to show the content in the new language. However, if the translation is not yet available, it shows the English version instead.",
"updated": 1613820612132,
"translations": [
]
},
{
"style": "Text",
"text": "Node types, variable names, the title of pages in the Docs, and a few more elements of Superalgos may not be translated, as they are unique identifiers of the said elements. You will always get those in English.",
"translations": [
]
},
{
"style": "Success",
"text": "If you wish to contribute translations, read the How to Contribute Translations page."
},
{
"style": "Success",
"text": "To switch languages, click on the flags on the footer of the Docs."
},
{
"style": "Note",
"text": "You may only add or delete pages to the Docs when the language is set to English.",
"updated": 1613820648230
}
]
}
Projects/Superalgos/Schemas/Docs-Topics/trading-farms-001-trading-farms-fundamental-concepts.json
+12 -7
View File
@@ -23,8 +23,8 @@
},
{
"style": "Text",
"text": "A Network, represented by the Network Hierarchy it is just a definition that allows the system to know where Tasks need to be run, and where data is hosted. At any workspace you mighd define one or even more than one Netwrok Hiererchy. For simplicity we will continue the explanation assuming only one Network is defined.",
"updated": 1614353405812
"text": "A Network, represented by the Network Hierarchy, is just a definition that allows the system to know where Tasks need to be run, and where data is hosted. At any workspace you might define one, or even more than one, Network Hierarchy. For simplicity, we will continue the explanation assuming only one Network is defined.",
"updated": 1617263502648
},
{
"style": "Text",
@@ -51,7 +51,8 @@
},
{
"style": "Text",
"text": "There are many different way you might want to organize the Tasks across several Clients. It is really up to you. The system don't care or have any preferred way for you to do so. It just need to know where each Task runs, and where the Data is located. That's it."
"text": "There are many different way you might want to organize the Tasks across several Clients. It is really up to you. The system doesn't care or have any preferred way for you to do so. It justs need to know where each Task runs, and where the Data is located. That's it.",
"updated": 1617263562866
},
{
"style": "Callout",
@@ -71,7 +72,8 @@
},
{
"style": "Callout",
"text": "In other words, the system allows building any arrangement of networks of nodes responding to the organizational logic of your preference."
"text": "In other words, the system allows building any arrangement of networks of nodes corresponding to the organizational logic of your preference.",
"updated": 1617263606632
},
{
"style": "Title",
@@ -80,11 +82,13 @@
},
{
"style": "Text",
"text": "When you define a Task, inside of it you are referencing a Process Definition, which has in turn definition regarding to which other processes it depends on (for example to start after some other process finished) and it also has Data Dependencies, which means that in order to run, it needs to read the data output from other processes."
"text": "When you define a Task, inside of it you are referencing a Process Definition, which has in turn a definition specifying which other processes it depends on (for example to start after some other process finished) and it also has Data Dependencies, which means that in order to run, it needs to read the data output from other processes.",
"updated": 1617263665349
},
{
"style": "Note",
"text": "All these definitions are built-in inside Data Mines, Trading Mines and Learning mines at a conceptual level. This means that a Data Mine does not really know where the data a process depends on actually is, or where a process that it depends on is actually running. That problem is solved at runtime once a Task is executed."
"text": "All these definitions are built-in inside Data Mines, Trading Mines and Learning mines at a conceptual level. This means that a Data Mine does not really know where the data a process depends on actually is, or where a process that it depends on, is actually running. That problem is solved at runtime once a Task is executed.",
"updated": 1617263712801
},
{
"style": "Text",
@@ -93,7 +97,8 @@
},
{
"style": "Text",
"text": "This is achieved by sending to a newly executed Task a snapshot of the Network Map at the instant when the Task is being run. From the Mine definition the Task can know which processes and data it depends on, and by looking into the snapshot of the Network, it can guess which Client is hosting the Data or the Tasks that the process depends on, allowing it to communicate with those Client s and fetch the data from them or wait for the right events signaling that the dependen process has finished."
"text": "This is achieved by sending to a newly executed Task a snapshot of the Network Map at the instant when the Task is being run. From the Mine definition the Task can know which processes and data it depends on, and by looking into the snapshot of the Network, it can guess which Client is hosting the Data or the Tasks that the process depends on, allowing it to communicate with those Clients, and fetch the data from them, or wait for the right events signaling that the dependent process has finished.",
"updated": 1617263799269
},
{
"style": "Title",
Projects/Superalgos/Schemas/Docs-Topics/trading-farms-002-trading-farms-set-up-a-network-of-nodes.json
+24 -19
View File
@@ -27,8 +27,8 @@
},
{
"style": "Text",
"text": "The procedure to setup a Network Node is by executing the Install Market menu option of a certain Market node. This is a complex procedure that will connect all the dots for you from A to Z. You can do by hand what this procedure does, but it will take you a lot of time and you will need to know all the details of how to connect everything together.",
"updated": 1614355139550
"text": "The procedure to setup a Network Node is by executing the Install Market menu option of a certain Market node. This is a complex procedure that will connect all the dots for you from A to Z. You can do by hand what this procedure does, but it will take you a lot of time, and you will need to know all the details of how to connect everything together.",
"updated": 1617263888269
},
{
"style": "Important",
@@ -36,12 +36,13 @@
},
{
"style": "Text",
"text": "For exmaple: if you have 2 trading systems, it will automatically create backtesting and live trading tasks for both of them.",
"updated": 1614355238724
"text": "For example: if you have 2 trading systems, it will automatically create backtesting and live trading tasks for both of them.",
"updated": 1617263908126
},
{
"style": "Text",
"text": "The procedure will also be applied to each Network Node found at the workspace assuming that you will later delete the Tasks or other branches you don't need. But in order to do so, you need to know what is being added as a result of this execution."
"text": "The procedure will also be applied to each Network Node found at the workspace, assuming that you will later delete the Tasks or other branches you don't need. But in order to do so, you need to know what is being added as a result of this execution.",
"updated": 1617263931507
},
{
"style": "Subtitle",
@@ -49,7 +50,8 @@
},
{
"style": "Text",
"text": "Here this procedure will essentially add 2 thigs:"
"text": "Here this procedure will essentially add 2 things:",
"updated": 1617263943061
},
{
"style": "List",
@@ -57,8 +59,8 @@
},
{
"style": "List",
"text": "Data Products: You can think of this as references to the physical data. This definitions are what tells the system in general where the data is physically located.",
"updated": 1614355507769
"text": "Data Products: You can think of this as references to the physical data. These definitions are what tells the system in general where the data is physically located.",
"updated": 1617263962570
},
{
"style": "Subtitle",
@@ -66,12 +68,13 @@
},
{
"style": "Text",
"text": "Here this procedure will add Time Machine s with Timeline Chart s inside of them. Deeper inside this brach, you will find Layer s node, which references the Data Products at the Network Hierarchy. That reference is crucial for the system to know when you turn on a Layer at the charts, where the data needs to be fetched from (which Client).",
"updated": 1614357169345
"text": "Here this procedure will add Time Machine s with Timeline Chart s inside of them. Deeper inside this branch, you will find Layer s node, which references the Data Products at the Network Hierarchy. That reference is crucial for the system to know when you turn on a Layer at the charts, where the data needs to be fetched from (which Client).",
"updated": 1617263990004
},
{
"style": "Success",
"text": "If you understand all the previous relationships, you can go ahead and install a market in all Network Node s at the same time, and then try to delete all the duplicated definitions. If you don't have all that clear, it is recommended that you install all your markets at one single Network Node and then move the braches you want from one Network Node to the other."
"text": "If you understand all the previous relationships, you can go ahead and install a market in all Network Node s at the same time, and then try to delete all the duplicated definitions. If you don't have all that clear, it is recommended that you install all your markets at one single Network Node and then move the branches you want from one Network Node to the other.",
"updated": 1617264010597
},
{
"style": "Title",
@@ -84,8 +87,8 @@
},
{
"style": "Text",
"text": "There are different types of Tasks and each one needs to be moved together with their corresponding Data Products definitions in order for the system to being able to track dependencies. The Data Products dedinitions are the one under the Data Storage node of a Network Node. They are subdivided in different branches depending of the Type of Data, Project, Exchange, Market and many other stuff, but in the end you will find Data Product nodes which reference Product Definitions inside Mines. When you move Tasks from one Network Node to other you also need to move the related brach at Data Storage to the same Network Node.",
"updated": 1614356433556
"text": "There are different types of Tasks and each one needs to be moved together with their corresponding Data Products definitions in order for the system to being able to track dependencies. The Data Products definitions are the ones under the Data Storage node of a Network Node. They are subdivided in different branches depending of the Type of Data, Project, Exchange, Market and many other stuff, but in the end you will find Data Product nodes which reference Product Definitions inside Mines. When you move Tasks from one Network Node to other you also need to move the related branch at Data Storage to the same Network Node.",
"updated": 1617264118423
},
{
"style": "Text",
@@ -97,12 +100,13 @@
},
{
"style": "Success",
"text": "The refinitions at the Charting System hirierchy do not need to be changed at all. They will continue pointing to the Data Products they were pointint to no matter where you moved those Data Products definitions. If you changed them from one Network Node to another, the Pltotter will simply fetch the data from the Network Node where you left thos Data Product s definitions."
"text": "The definitions at the Charting System hierarchy do not need to be changed at all. They will continue pointing to the Data Products they were pointed to no matter where you moved those Data Products definitions. If you changed them from one Network Node to another, the Plotter will simply fetch the data from the Network Node where you left those Data Product s definitions.",
"updated": 1617264173906
},
{
"style": "Note",
"text": "Whey we say moving what we are saying is detaching a Node brach and re attaching that same brach somewhere else. Note that if you for example make a backup of a branch, restore that somehwhere else without deleting the original branch first, you will inadvertently be creating new ids for each Node at this branch and messing up with incomming references, which will produce things not to work anymoere.",
"updated": 1614357412126
"text": "When we say moving, what we are saying is detaching a Node branch and re-attaching that same branch somewhere else. Note that if you, for example, make a backup of a branch, restore that somehwhere else without deleting the original branch first, you will inadvertently be creating new ids for each Node at this branch and messing up the incoming references, which will cause things to not work anymore.",
"updated": 1617264249424
},
{
"style": "Text",
@@ -155,8 +159,8 @@
},
{
"style": "Success",
"text": "For organizational purposes and to avoid confusion later on, it is recommended to clean up the home node’s workspace uninstalling the markets that you don’t need.",
"updated": 1611343505445
"text": "For organizational purposes and to avoid confusion later on, it is recommended to clean up the home node’s workspace, uninstalling the markets that you don’t need.",
"updated": 1617264320991
},
{
"style": "Text",
@@ -189,7 +193,8 @@
},
{
"style": "List",
"text": "host is the machine or hardware represented by the network node. The default parameter is localhost, but if you intend to access the Client services of this node from a remote computer, then you must change localhost for the IP Address of the machine on which the node is running, for example, to 147.0.0.1."
"text": "host is the machine or hardware represented by the network node. The default parameter is localhost, but if you intend to access the Client services of this node from a remote computer, then you must change localhost for the IP Address of the machine on which the node is running, for example, to 147.0.0.1. Use the dotted IP address rather than a host name, since this reduces host name lookups.",
"updated": 1617264451129
},
{
"style": "List",
Projects/Superalgos/UI/Spaces/Docs-Space/Footer.js
+6
View File
@@ -105,6 +105,12 @@ function newSuperalgosDocsFooter() {
}
HTML = HTML + '"></a>'
HTML = HTML + '<a href="#" onClick="UI.projects.superalgos.spaces.docsSpace.changeLanguage(\'TR\')"><img src="Images/Languages/TR.png" title="Turkish" class="docs-footer-language'
if (languageCode === 'TR') {
HTML = HTML + '-selected'
}
HTML = HTML + '"></a>'
HTML = HTML + '</div>'
HTML = HTML + '<div class="docs-footer-cell">'
Projects/Superalgos/UI/Utilities/Languages.js
+4
View File
@@ -32,6 +32,10 @@ function newSuperalgosUtilitiesLanguages() {
languageLabel = 'Bahasa'
break
}
case 'TR': {
languageLabel = 'Turkish'
break
}
}
return languageLabel
}
README.md
+52 -36
View File
@@ -2,11 +2,13 @@
All procedures are the same for Windows, Linux, or Mac OS. Raspberry Pi terminal commands have been included for ease of use.
> **IMPORTANT:** Minimalist hardware —both virtual and physical— is 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 GIU 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 minimalist hardware for when you are ready to start trading live.
![superalgos-readme](https://user-images.githubusercontent.com/13994516/106380124-844d8980-63b0-11eb-9bd9-4f977b6c183b.gif)
# Pre-Requisites
## Node JS
## 1. Node JS
If you don't have it yet, download and install Node.js.
@@ -35,7 +37,7 @@ you may also type the following to verify the Node.js installation and version.
node -v
```
## Git
## 2. Git
Download and install Git.
@@ -52,12 +54,12 @@ Git is an open-source distributed version control system required to download an
**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.
**NOTE FOR RASPBERRY PI USERS:**
send the SSH Terminal command to install git. The most recent version of PiOS has Git already installed, so this may give you an error. The error will not affect your installation.
Send the SSH Terminal command to install git. 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
```
## Google Chrome or Safari
## 3. Google Chrome or Safari
Use Chrome, or Safari on Mac. These are the only tested browsers.
@@ -71,13 +73,17 @@ Before you begin, it is recommended that you set up Chrome/Safari as your defaul
# Superalgos Client Installation
**1.** 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.
## 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.** Once the fork is created, you will land on the page of your fork. Copy the URL from your browser's address bar.
## 2. Clone Your Fork
**3.** 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
**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>
@@ -89,17 +95,19 @@ 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. To run the App, jump to the section Usage below.
This creates the `Superalgos` folder in the current directory, which contains the whole installation.
## Installation Notes
> **The Usage section below explains how to run the app.**
**1.** 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.
## 3. Installation Notes
**2.** 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).
**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.
**3.** 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 server 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.
**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).
## Migrating from Superalgos Beta 8
**C.** 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.
## 4. Migrating from Superalgos Beta 8
### Refactorings
@@ -122,15 +130,24 @@ In order to migrate your own workspaces to Beta 9, you will need to open My Work
### Renaming of Exchange Folders
In Beta 9 the exchange id is used at the code and folder name instead of the exchange name. So to migrate to Beta 9 users at key sensitive OS must rename their Data Storage Exchange folders for the Id of the exchange that in the case of Binance is the same name with lower B: binance. If you are using a different exchange, look at it's node config and use the value at the property codeName as a folder name at your Data Storage folder.
In Beta 9, the `exchange id` is used at the code and folder names instead of the exchange name. To migrate to Beta 9 users running on case sensitive Operating Systems (like Linux) must rename their Data-Storage Exchange folders using the Id of the exchange (in the case of Binance, it's the same name, but with lower-case b: binance). If you are using a different exchange, look at its node configuration and use the value at the property `codeName` to name the folder.
# Usage
**1.** To run the Superalgos client, go to the Superalgos directory/folder and run this command:
## 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) it is recommended to use the following instead.
```
cd Superalgos
@@ -140,22 +157,13 @@ then
node run minMemo noBrowser
```
## 2. Usage Notes
![run-the-system-01](https://user-images.githubusercontent.com/13994516/107037804-e5fc6200-67bb-11eb-82f2-d0f40247fa14.gif)
![run-the-system-01](https://user-images.githubusercontent.com/13994516/107037804-e5fc6200-67bb-11eb-82f2-d0f40247fa14.gif)
**2.** The command launches your default browser to load the UI. 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 UI.
**3.** 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.
## Usage Notes
**1.** 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.
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
# 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.
@@ -210,16 +218,24 @@ Once the app finishes loading, an interactive tutorial takes you by the hand and
# Docker Deployments
- NEW: Added github action to publish docker image into github package registry
If you wish to run Superalgos over docker platform, follow these steps.
## Docker Image
If you want to run superalgos over docker platform, you should follow the next steps:
1. [Install docker](https://docs.docker.com/engine/install/)
2. `docker login ghcr.io --username your-github-username --password-stdin`
3. `docker run -p 18041:18041 -p 34248 superalgos/superalgos`
4. Now you can access to the superalgos UI
## 1. Install Docker
Note: This has not been extensively tested yet, if you run into troubles, please contact us at our [Superalgos User's Support Group](https://t.me/superalgossupport).
Follow the link to [install docker](https://docs.docker.com/engine/install/).
## 2. Login and Run
```
docker login ghcr.io --username your-github-username --password-stdin
```
```
docker run -p 18041:18041 -p 34248 superalgos/superalgos
```
Now you can access to the Superalgos UI.
**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).
# What is Superalgos?
@@ -384,7 +400,7 @@ Superalgos is a Community Project built by users for users. Learn [how you may c
## Top Contributors
Luis Fernando Molina, Julian Molina, Andreja Cobeljic, Matías Benitez, Ira Miller, Eduardo Remis, Jeff Braun, rico4dev, 9808us, Barry Low, Nikola Bjelogrlic, Hirajin Koizuko, Francisco J. Santillán, Norman, Viktoria B., Guillermo V., Carl J, Daniel J., Javier A., Gustavo J., Romina GS, Pedro P., Thais M., Andrey M., Loui M., Natalia M., Bashar A., Carlos V., Diego M., CarnivalBen, Sebastian E., Bogdan P., Marko V., Igor S., Niksa K., Rodrigo M., Nicanor M., Alejandro P., Mateo H., Lan T., Leon A., Uroš R., Filip M., Vladimir J. and Pavle B.
Luis Fernando Molina, Julian Molina, Andreja Cobeljic, Ira Miller, matbenitez, bearcanrun, nikolabjelo, 9808us, pmmax, suttridge, Basalt09, Mhnramin, 0xperez, infin1t3, benitezme, whtv, cozed-gh, Eduardo678-dotcom, Smidy13, teehanming, 64bittuning, joenij, apronotti, Noeljarillo, ssplatt, rico4dev, DougJCook, mane, Cordo-van-Saviour, CarnivalBen, Sil3ntLight, pisukesoramame, Edodi, harrellbm, CaptainJeff, Jeff Braun, Francisco J. Santillán, Norman, Viktoria B., Guillermo V., Daniel J., Javier A., Gustavo J., Romina GS, Pedro P., Thais M., Andrey M., Loui M., Natalia M., Bashar A., Carlos V., Diego M., Sebastian E., Bogdan P., Marko V., Igor S., Niksa K., Rodrigo M., Nicanor M., Mateo H., Lan T., Leon A., Uroš R., Filip M., Vladimir J. and Pavle B.
# License