Merge branch 'develop' of https://github.com/Superalgos/Superalgos into develop

This commit is contained in:
Luis Fernando Molina committed 2021-01-20 09:03:40 +01:00
commit 4a3bd32d6e
33 files changed
+88 -247

No files matched your search

+14 -14
View File
@@ -25,8 +25,8 @@ font-weight: bold;
.tutorial-definitionTable {
background-color: #f3f3f3;
border-top-color: #a6e1ec;
padding: 15px;
margin: 20px 0;
padding: 14px;
margin: 18px 0;
border: solid 0px;
vertical-align: middle;
min-width: 100px;
@@ -36,10 +36,10 @@ width: 100%;
.tutorial-alert-info {
color: #31708f;
background-color: #d9edf7;
padding: 15px;
padding: 14px;
border: 1px solid rgba(49, 112, 143, .3);
border-radius: 4px;
margin: 20px 0;
margin: 18px 0;
width: 100%;
box-sizing: border-box;
}
@@ -47,10 +47,10 @@ box-sizing: border-box;
.tutorial-alert-success {
color: #3c763d;
background-color: #dff0d8;
padding: 15px;
padding: 14px;
border: 1px solid rgba(60, 118, 61, .3);
border-radius: 4px;
margin: 20px 0;
margin: 18px 0;
width: 100%;
box-sizing: border-box;
}
@@ -58,10 +58,10 @@ box-sizing: border-box;
.tutorial-alert-important {
color: #5e3e07;
background-color: #fcf8e3;
padding: 15px;
padding: 14px;
border: 1px solid rgba(138, 109, 59, .3);
border-radius: 4px;
margin: 20px 0;
margin: 18px 0;
width: 100%;
box-sizing: border-box;
}
@@ -69,17 +69,17 @@ box-sizing: border-box;
.tutorial-alert-warning {
color: #a94442;
background-color: #f2dede;
padding: 15px;
padding: 14px;
border: 1px solid rgba(169, 68, 66, .3);
border-radius: 4px;
margin: 20px 0;
margin: 18px 0;
width: 100%;
box-sizing: border-box;
}
.tutorial-callout {
padding: 20px;
margin: 20px 0;
padding: 18px;
margin: 18px 0;
border: 1px solid #eee;
border-left-width: 5px;
border-radius: 3px;
@@ -145,7 +145,7 @@ font:normal normal normal 32px/1 "segoeui";
text-rendering:auto;
-webkit-font-smoothing:antialiased;
-moz-osx-font-smoothing:grayscale;
line-height: 150%
line-height: 100%
}
.tutorial-font-large {
@@ -153,7 +153,7 @@ font:bold normal normal 40px/1 "segoeui";
text-rendering:auto;
-webkit-font-smoothing:antialiased;
-moz-osx-font-smoothing:grayscale;
line-height: 150%
line-height: 100%
}
.tutorial-font-bold-small {
BIN
View File
Binary file not shown.
@@ -1 +1 @@
{"type":"Workspace","name":"Getting Started","rootNodes":[{"type":"Network","name":"My Network","project":"Superalgos","networkNodes":[{"type":"Network Node","name":"My Computer","config":"{ \n\"host\": \"localhost\", \n\"webPort\": \"34248\", \n\"webSocketsPort\": \"18041\"\n}","project":"Superalgos","dataTasks":{"type":"Data Tasks","name":"New Data Tasks","project":"Superalgos","projectDataTasks":[{"type":"Project Data Tasks","name":"Superalgos","project":"Superalgos","exchangeDataTasks":[{"type":"Exchange Data Tasks","name":"Binance","project":"Superalgos","marketDataTasks":[{"type":"Market Data Tasks","name":"Binance BTC/USDT","project":"Superalgos","dataMineTasks":[{"type":"Data Mine Tasks","name":"Masters","project":"Superalgos","taskManagers":[{"type":"Task Manager","name":"Masters","project":"Superalgos","tasks":[{"type":"Task","name":"Exchange Raw Data","project":"Superalgos","bot":{"type":"Sensor Bot Instance","name":"Exchange Raw Data","config":"{ \n\"startDate\": \"2020-01-01\"\n}","project":"Superalgos","processes":[{"type":"Sensor Process Instance","name":"Exchange Raw Data Historic-OHLCVs","project":"Superalgos","id":"d244c564-4e86-43c7-9796-dc3b6294ec8b","savedPayload":{"position":{"x":23490.023749611923,"y":29239.135911211026},"targetPosition":{"x":23779.801497498644,"y":29316.781624741783},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false},"referenceParent":{"type":"Process Definition","name":"Historic-OHLCVs","id":"5eb11d6a-022e-4f60-97c4-d6cf90b249dc"}}}],"id":"343313ae-5705-484d-8bf8-aed25ba61cfa","savedPayload":{"position":{"x":23779.801497498644,"y":29316.781624741783},"targetPosition":{"x":24069.579245385365,"y":29394.42733827254},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false}}},"id":"a8f38508-1cac-4ab1-815f-d338fc813377","savedPayload":{"position":{"x":24069.579245385365,"y":29394.42733827254},"targetPosition":{"x":24359.356993272086,"y":29472.073051803298},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false}}},{"type":"Task","name":"Candles Volumes","project":"Superalgos","bot":{"type":"Indicator Bot Instance","name":"Candles Volumes","config":"{}","project":"Superalgos","processes":[{"type":"Indicator Process Instance","name":"Candles Volumes Multi-Period-Market","project":"Superalgos","id":"f0ef12ed-f0fd-4b88-8e15-27cf24265a5f","savedPayload":{"position":{"x":23799.549372136753,"y":28802.457809532632},"targetPosition":{"x":24059.356993272086,"y":28952.457809532632},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false},"referenceParent":{"type":"Process Definition","name":"Multi-Period-Market","id":"9f683143-a33f-42c1-9fa8-c601f01ee4e1"}}},{"type":"Indicator Process Instance","name":"Candles Volumes Multi-Period-Daily","project":"Superalgos","id":"7c8b312c-09bf-4c59-853f-1592391a9c57","savedPayload":{"position":{"x":24059.356993272086,"y":28652.457809532632},"targetPosition":{"x":24059.356993272086,"y":28952.457809532632},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false},"referenceParent":{"type":"Process Definition","name":"Multi-Period-Daily","id":"980ceb1d-7be6-454f-90d9-01ba1fd4a65d"}}}],"id":"8d58e84b-d7ef-464f-8079-0ec0887e3da3","savedPayload":{"position":{"x":24059.356993272086,"y":28952.457809532632},"targetPosition":{"x":24209.356993272086,"y":29212.265430667965},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false}}},"id":"bf29e3bd-9386-408b-9091-042da0c53e81","savedPayload":{"position":{"x":24209.356993272086,"y":29212.265430667965},"targetPosition":{"x":24359.356993272086,"y":29472.073051803298},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false}}},{"type":"Task","name":"Resistances and Supports","project":"Superalgos","bot":{"type":"Indicator Bot Instance","name":"Resistances and Supports","config":"{}","project":"Superalgos","processes":[{"type":"Indicator Process Instance","name":"Resistances and Supports Multi-Period-Market","project":"Superalgos","id":"a707814e-b81b-4102-9b5b-4e2fe969324f","savedPayload":{"position":{"x":24437.002706802843,"y":28602.739808143135},"targetPosition":{"x":24514.6484203336,"y":28892.517556029856},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false},"refeLine truncated
{"type":"Workspace","name":"Getting Started","rootNodes":[{"type":"Network","name":"My Network","project":"Superalgos","networkNodes":[{"type":"Network Node","name":"My Computer","config":"{ \n\"host\": \"localhost\", \n\"webPort\": \"34248\", \n\"webSocketsPort\": \"18041\"\n}","project":"Superalgos","dataTasks":{"type":"Data Tasks","name":"New Data Tasks","project":"Superalgos","projectDataTasks":[{"type":"Project Data Tasks","name":"Superalgos","project":"Superalgos","exchangeDataTasks":[{"type":"Exchange Data Tasks","name":"Binance","project":"Superalgos","marketDataTasks":[{"type":"Market Data Tasks","name":"Binance BTC/USDT","project":"Superalgos","dataMineTasks":[{"type":"Data Mine Tasks","name":"Masters","project":"Superalgos","taskManagers":[{"type":"Task Manager","name":"Masters","project":"Superalgos","tasks":[{"type":"Task","name":"Exchange Raw Data","project":"Superalgos","bot":{"type":"Sensor Bot Instance","name":"Exchange Raw Data","config":"{ \n\"startDate\": \"2020-01-01\"\n}","project":"Superalgos","processes":[{"type":"Sensor Process Instance","name":"Exchange Raw Data Historic-OHLCVs","project":"Superalgos","id":"d244c564-4e86-43c7-9796-dc3b6294ec8b","savedPayload":{"position":{"x":23490.023749611923,"y":29239.135911211026},"targetPosition":{"x":23779.801497498644,"y":29316.781624741783},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false},"referenceParent":{"type":"Process Definition","name":"Historic-OHLCVs","id":"5eb11d6a-022e-4f60-97c4-d6cf90b249dc"}}}],"id":"343313ae-5705-484d-8bf8-aed25ba61cfa","savedPayload":{"position":{"x":23779.801497498644,"y":29316.781624741783},"targetPosition":{"x":24069.579245385365,"y":29394.42733827254},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false}}},"id":"a8f38508-1cac-4ab1-815f-d338fc813377","savedPayload":{"position":{"x":24069.579245385365,"y":29394.42733827254},"targetPosition":{"x":24359.356993272086,"y":29472.073051803298},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false}}},{"type":"Task","name":"Candles Volumes","project":"Superalgos","bot":{"type":"Indicator Bot Instance","name":"Candles Volumes","config":"{}","project":"Superalgos","processes":[{"type":"Indicator Process Instance","name":"Candles Volumes Multi-Period-Market","project":"Superalgos","id":"f0ef12ed-f0fd-4b88-8e15-27cf24265a5f","savedPayload":{"position":{"x":23799.549372136753,"y":28802.457809532632},"targetPosition":{"x":24059.356993272086,"y":28952.457809532632},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false},"referenceParent":{"type":"Process Definition","name":"Multi-Period-Market","id":"9f683143-a33f-42c1-9fa8-c601f01ee4e1"}}},{"type":"Indicator Process Instance","name":"Candles Volumes Multi-Period-Daily","project":"Superalgos","id":"7c8b312c-09bf-4c59-853f-1592391a9c57","savedPayload":{"position":{"x":24059.356993272086,"y":28652.457809532632},"targetPosition":{"x":24059.356993272086,"y":28952.457809532632},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false},"referenceParent":{"type":"Process Definition","name":"Multi-Period-Daily","id":"980ceb1d-7be6-454f-90d9-01ba1fd4a65d"}}}],"id":"8d58e84b-d7ef-464f-8079-0ec0887e3da3","savedPayload":{"position":{"x":24059.356993272086,"y":28952.457809532632},"targetPosition":{"x":24209.356993272086,"y":29212.265430667965},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false}}},"id":"bf29e3bd-9386-408b-9091-042da0c53e81","savedPayload":{"position":{"x":24209.356993272086,"y":29212.265430667965},"targetPosition":{"x":24359.356993272086,"y":29472.073051803298},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false}}},{"type":"Task","name":"Resistances and Supports","project":"Superalgos","bot":{"type":"Indicator Bot Instance","name":"Resistances and Supports","config":"{}","project":"Superalgos","processes":[{"type":"Indicator Process Instance","name":"Resistances and Supports Multi-Period-Market","project":"Superalgos","id":"a707814e-b81b-4102-9b5b-4e2fe969324f","savedPayload":{"position":{"x":24437.002706802843,"y":28602.739808143135},"targetPosition":{"x":24514.6484203336,"y":28892.517556029856},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false},"refeLine truncated
@@ -18,11 +18,13 @@
},
{
"style": "List",
"text": "To control your data mining operation—that is, tasks running sensor and indicator bots. Data mining tasks process data that may be consumed by others; for example, so that your trading systems may count with quality information."
"text": "To control your data mining operation — that is, tasks running sensor and indicator bots. Data mining tasks process data that may be consumed by others; for example, so that your trading systems may count with quality information.",
"updated": 1611058647352
},
{
"style": "List",
"text": "To control your testing environment—that is, trading sessions including backtesting and paper trading sessions."
"text": "To control your testing environment — that is, trading sessions including backtesting and paper trading sessions.",
"updated": 1611073262412
},
{
"style": "List",
@@ -3,14 +3,14 @@
"pageNumber": "1",
"type": "App Error - Contribution Not Sent",
"definition": {
"text": "There was a problmen trying to send your contribution to your fork of the Superalgos repository, or from your fork to the Superalgos/Superalgos main repository.",
"updated": 1610441932801
"text": "There was a problem trying to send your contribution to your fork of the Superalgos repository, or from your fork to the Superalgos/Superalgos main repository.",
"updated": 1611129378492
},
"paragraphs": [
{
"style": "Text",
"text": "You will need to check for the Client's console for details on what happened. After you fix the issue that prevented the App Contribute Command to run, you might try again.",
"updated": 1610441999433
"text": "Check for the Client's console for details on what may have happened. After you fix the issue that prevented the App Contribute Command to run, you may try again.",
"updated": 1611129009743
}
]
}
@@ -3,8 +3,8 @@
"pageNumber": "2",
"type": "App Error - Github Credentials Missing",
"definition": {
"text": "In order to manage contributions from within the app, or update the app by running a command; you first need to provide your Github.com credentials so that we can get you authenticated when pushing your changes to the remote repository.",
"updated": 1610449696988
"text": "To manage contributions from within the app or update the app by running a command, you must first provide your Github.com credentials so that the Client can get you authenticated when pushing your changes to the remote repository.",
"updated": 1611129104270
},
"paragraphs": [
{
@@ -3,12 +3,14 @@
"pageNumber": "3",
"type": "App Error - Update Failed",
"definition": {
"text": "Write here a summary for this topic page."
"text": "There was a problem trying to update the Client. Check the console for errors and make sure your GitHub.com credentials are correct.",
"updated": 1611129344277
},
"paragraphs": [
{
"style": "Text",
"text": "Left click and Edit to enter edit mode and change this text. ENTER to write new paragraphs. ESC to exit edit mode."
"style": "Success",
"text": "Check for the Client's console for details on what may have happened. After you fix the issue, you may try again.",
"updated": 1611129360143
}
]
}
@@ -1,16 +0,0 @@
{
"topic": "App Commands Messages",
"pageNumber": "1",
"type": "App Message - Contribution Done",
"definition": {
"text": "Your contributions were uploaded to your Superalgo's Fork and from there a Pull Request was submitted to the main Superalgos's repository.",
"updated": 1610478517848
},
"paragraphs": [
{
"style": "Success",
"text": "There is no further action from you required. Someone will review your changes and merge them into the latest version of the software. If your changes are rejected for any reason, you will have to follow the issue at the Github.com web site. ",
"updated": 1610712264828
}
]
}
@@ -14,8 +14,8 @@
},
{
"style": "Text",
"text": "No further action from you is required. Someone will review your Pull Request and merge it into the latest version of the software should everything be in order. If your changes are rejected for any reason, you will have to follow the issue at Github.com.",
"updated": 1611002796639
"text": "No further action from you is required. Someone will review your Pull Request and merge it into the latest version of the software should everything be in order. If your changes are rejected for any reason, you will have to follow up with the issue at Github.com.",
"updated": 1611128895749
},
{
"style": "Text",
@@ -1,16 +0,0 @@
{
"topic": "App Commands Messages",
"pageNumber": "4",
"type": "App Message - Update Done - New Version Found",
"definition": {
"text": "The update process ran successfully. It found a new version of Superalgos and it download it replacing the current one. In order for the new changes to take effect, you need to restart the Client and refresh the UI page.",
"updated": 1610454363656
},
"paragraphs": [
{
"style": "Success",
"text": "You now have the latest version of Superalgos. Just remeber to restart the Client and the UI.",
"updated": 1610454408134
}
]
}
@@ -3,8 +3,8 @@
"pageNumber": "5",
"type": "App Message - Update Done - Already Up-To-Date",
"definition": {
"text": "The update process run successfully but no changes where made since your installation is up-to-date with the selected branch. No further action required.",
"updated": 1611003139749
"text": "The update process run successfully but no changes where made since your installation is up-to-date with the current branch. No further action required.",
"updated": 1611128829429
},
"paragraphs": [
{
@@ -1,16 +0,0 @@
{
"topic": "App Commands Messages",
"pageNumber": "5",
"type": "App Message - Update Done - Already Up-To-Date",
"definition": {
"text": "The update process was executed successfully, but no changes where found since you were running the latest version of Superalgos. No further action need to be taken.",
"updated": 1610454235682
},
"paragraphs": [
{
"style": "Success",
"text": "You are up-to-date. No need to reboot the Client or refresh the UI page.",
"updated": 1610454271911
}
]
}
@@ -1,14 +0,0 @@
{
"topic": "Branches Management Messages",
"pageNumber": "2",
"type": "Switching Branches - Current Branch Changed",
"definition": {
"text": "Write here a summary for this topic page."
},
"paragraphs": [
{
"style": "Text",
"text": "Left click and Edit to enter edit mode and change this text. ENTER to write new paragraphs. ESC to exit edit mode."
}
]
}
@@ -1,14 +0,0 @@
{
"topic": "Branches Management Messages",
"pageNumber": "4",
"type": "Switching Branches - Current Branch Not Changed",
"definition": {
"text": "Write here a summary for this topic page."
},
"paragraphs": [
{
"style": "Text",
"text": "Left click and Edit to enter edit mode and change this text. ENTER to write new paragraphs. ESC to exit edit mode."
}
]
}
@@ -1,44 +0,0 @@
{
"topic": "Docs Commands",
"pageNumber": "7",
"type": "Docs Repaginate Command",
"definition": {
"text": "When you add a Docs Topic Page or a Docs Tutorial Page, you define the page number for it, that is will ultimately defines the position of the page within that topic or tutorial table of contents. The technique to add a page in-between other pages is to use decimal values. After that you can use the Repaginate command in order to recalculate all page numbers and leave the whole set with integer numbers.",
"updated": 1610392867410
},
"paragraphs": [
{
"style": "Title",
"text": "Syntax",
"updated": 1610393031768
},
{
"style": "Javascript",
"text": "docs.repaginate Category from Project: Topic or Tutorial name."
},
{
"style": "Title",
"text": "Properties"
},
{
"style": "List",
"text": "Category: It must be either Topic or Tutorial."
},
{
"style": "List",
"text": "Project: Any existing already integrated project."
},
{
"style": "List",
"text": "Topic or Tutorial name: The name given tu the Topic or Tutorial that you want to repaginate."
},
{
"style": "Title",
"text": "Example"
},
{
"style": "Javascript",
"text": "docs.repaginate Topic from Superalgos: Docs Commands"
}
]
}
@@ -1,30 +0,0 @@
{
"topic": "Docs Commands Errors",
"pageNumber": "17",
"type": "No Matching Topic, Tutorial or Review Found",
"definition": {
"text": "The Topic or Tutorial you specified did not produce any match of pages within that Topic or Tutorial.",
"updated": 1610398888306
},
"paragraphs": [
{
"style": "Error",
"text": "No pages found. There are no Topics or Tutorials with the name provided.",
"updated": 1610398925565
},
{
"style": "Success",
"text": "Tip: Check that the name Topic or Tutorial name provided is correctly spelled.",
"updated": 1610398957505
},
{
"style": "Title",
"text": "Applies to"
},
{
"style": "List",
"text": "Docs Repaginate Command",
"updated": 1610398971728
}
]
}
@@ -1,35 +1,38 @@
{
"tutorial": "Welcome to Superalgos!",
"pageNumber": 2,
"type": "Tutorial Step - Use Chrome or Chrome!",
"type": "Tutorial Step - Use Chrome or Safari!",
"definition": {
"icon": {
"project": "Superalgos",
"name": "bullet-warning"
},
"text": "When running the frontend, we highly recommend using Chrome! We are not testing on any other browsers!",
"text": "When running the frontend, use Chrome, or Safari on Mac! We are not testing on any other browsers!",
"updated": 1610612226890
},
"paragraphs": [
{
"style": "Text",
"text": "It is a well-known fact that browsers behave differently, and we do know of features that do not work on other browsers. If you are on Chrome, click Next and continue. If not, do the following:"
"text": "It is a well-known fact that browsers behave differently, and we do know of features that do not work on other browsers. If you are on Chrome or Safari, click Next and continue. If not, do the following:"
},
{
"style": "List",
"text": "Copy the current URL. "
"text": "copy the current URL;",
"updated": 1611086562247
},
{
"style": "List",
"text": "Close this browser as is. Do not close the tutorial!"
"text": "close this browser as is; do not close the tutorial...",
"updated": 1611086588055
},
{
"style": "List",
"text": "Open Chrome and paste the URL. The tutorial should be open on this step when you come back."
"text": "open Chrome/Safari and paste the URL; the tutorial should be open on this step when you come back!",
"updated": 1611086617811
},
{
"style": "Warning",
"text": "We offer online support, but we can't help you with any browser other than Chrome!"
"text": "We offer online support, but we can't help you with any other browser!"
}
]
}
@@ -16,11 +16,8 @@
},
{
"style": "Callout",
"text": "Hover your mouse pointer over the Tutorial node and see what happens!"
},
{
"style": "Text",
"text": "Wow! Cool right? That's a lot of buttons!"
"text": "Hover your mouse pointer over the Tutorial node and see what happens! Wow! Cool right? That's a lot of buttons!",
"updated": 1611075799669
}
]
}
@@ -20,11 +20,8 @@
},
{
"style": "Text",
"text": "See the nodes I mentioned earlier? Cool! We are here to start your first ever data mining operation."
},
{
"style": "Note",
"text": "But before we start, I have a question for you! Are you accessing the Client remotely?"
"text": "See the nodes I mentioned earlier? Cool! We are here to start your first ever data mining operation. But before we start, I have a quick question for you: are you accessing the Client remotely?",
"updated": 1611075903071
}
]
}
@@ -16,7 +16,8 @@
},
{
"style": "Warning",
"text": "At this stage, Superalgos does not implement any form of security measures. Therefore, you should use the system in the context of a restricted Local Area Network only. If you chose to run the Client in the cloud, you must implement your own network security."
"text": "At this stage, Superalgos does not implement any form of security. You should use the system in the context of a restricted Local Area Network only. If you chose to run the Client in the cloud, you must implement your own security.",
"updated": 1611076067427
}
]
}
@@ -16,7 +16,8 @@
},
{
"style": "Callout",
"text": "If you trade at binance.us you need to do something with the Binance node to the right! The video on the next step shows you how!"
"text": "If you trade at binance.us you need to configure the Binance node to the right! The video on the next step shows you how!",
"updated": 1611076107190
},
{
"style": "List",
@@ -7,16 +7,14 @@
"project": "Superalgos",
"name": "run"
},
"text": "The Run All Project Data Tasks button on the top-right corner of the Data Tasks node menu runs... well... all Project Data Tasks!"
"text": "Open the Data Tasks node menu and find the Run All Project Data Tasks button on the top-right corner...",
"updated": 1611076262685
},
"paragraphs": [
{
"style": "Text",
"text": "And that is exactly what we want to do, so..."
},
{
"style": "Callout",
"text": "Select the button on the menu and let's mine!"
"text": "Click the Run All Project Data Tasks button!",
"updated": 1611076332667
},
{
"style": "Text",
@@ -16,7 +16,8 @@
},
{
"style": "Callout",
"text": "What happens after Candles Volumes finishes?"
"text": "What happens after she finishes?",
"updated": 1611076432059
},
{
"style": "Text",
@@ -16,7 +16,8 @@
},
{
"style": "Callout",
"text": "Right-click to open the map and left-click anywhere on the map to go to that specific spot!"
"text": "Right-click to open the map and left-click anywhere to go to that specific spot!",
"updated": 1611076477382
},
{
"style": "Text",
@@ -16,7 +16,8 @@
},
{
"style": "Callout",
"text": "Hit Ctrl and scroll the wheel of your mouse!"
"text": "Hit Ctrl and scroll the mouse wheel!",
"updated": 1611076507997
},
{
"style": "Text",
@@ -12,11 +12,8 @@
"paragraphs": [
{
"style": "Text",
"text": "This is likely the most important bit:"
},
{
"style": "List",
"text": "You are the boss! You may stop a tutorial and skip steps—or entire topics—at any point. Once you're ready to pick up the lesson again, find us on the bottom-left corner of the design space. Select Resume on the menu to start where you left, or on the first step skipped. Select Play to start from the beginning!"
"text": "This is likely the most important bit: you are the boss! You may stop a tutorial and skip steps—or entire topics—at any point. Once you're ready to pick up the lesson again, find us on the bottom-left corner of the design space. Select Resume on the menu to start where you left, or on the first step skipped. Select Play to start from the beginning!",
"updated": 1611076579955
},
{
"style": "Callout",
@@ -20,7 +20,8 @@
},
{
"style": "Callout",
"text": "Find the Need a Quick Reminder? step under the Tutorials & Help topic below. Then click Stop, and restart by clicking Play on the said Tutorial Step!"
"text": "Need a Quick Reminder? Find the step under the Tutorials & Help topic below. Then click Stop, and restart by clicking Play on the said Tutorial Step!",
"updated": 1611076850328
}
]
}
@@ -16,15 +16,10 @@
"text": "app.contribute My Superalgos Review",
"updated": 1610984455117
},
{
"style": "Success",
"text": "A GitHub sing in dialog should pop-up offering you to authenticate with your token or password. Just follow the process with either! ",
"updated": 1610984629613
},
{
"style": "Important",
"text": "The latest version of Git is required for this to work! If you have issues authenticating with the latest version, restarting the PC may help.",
"updated": 1610913072372
"text": "On Windows, a GitHub sign in dialog pops-up offering to authenticate with your token or password. Either should work! Remember that the latest version of Git is required! If you have issues with the latest version, restarting the PC may help. On Mac, it is the Terminal that asks for credentials. If you enabled two-factor authentication on GitHub, use the token even if asked for the password!",
"updated": 1611084396818
}
]
}
+20 -26
View File
@@ -1,6 +1,6 @@
# Quick Getting Started Guide
# Getting Started Guide
All procedures are the same for Windows, Linux, or Mac OS. Note: tested only on Google Chrome.
All procedures are the same for Windows, Linux, or Mac OS.
![Superalgos video capture (16)](https://user-images.githubusercontent.com/9479367/77251218-76d25980-6c4d-11ea-8e47-be7db2e8abdb.gif)
@@ -20,9 +20,7 @@ Node JS is an open-source server environment required to run Superalgos.
## Git
Download and install Git.
**Important:** The latest version of Git is required.
Download and install Git.
Git is an open-source distributed version control system required to download and stay up to date with Superalgos.
@@ -32,27 +30,29 @@ Git is an open-source distributed version control system required to download an
**c.** Run the installer with the default configuration — just click Next until Git is fully installed.
## Google Chrome
**IMPORTANT:** The latest version of Git is required to handle the authentication with GitHub.com.
Use Chrome, the only tested browser.
**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.
## 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 as your default browser.
Before you begin, it is recommended that you set up Chrome/Safari as your default browser.
**Important:** Use Chrome 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.
**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.** If you are not there already, go to [https://github.com/Superalgos/Superalgos](https://github.com/Superalgos/Superalgos)
**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. A Fork is required for your contributions to the project and to stay up to date with the latest version of the software (more on this later).
**2.** 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. A Fork is required for your contributions to the project and to stay up to date with the latest version of the software (more on this later).
**2.** Once the fork is created, you will land on the page of your fork. Copy the URL from your browser's address bar.
**3.** Once the fork is created, you will land on the page of your fork. Copy the URL from your browser's address bar.
**4.** In your computer/laptop/server, open a command prompt or terminal as an administrator (to avoid issues with permissions) and type:
**3.** In your computer/laptop/server, open a command prompt or terminal as an administrator (to avoid issues with permissions) and type:
```
git clone
@@ -70,17 +70,11 @@ For example, if your Github username is John, the command will look like this:
git clone https://github.com/John/Superalgos
```
**5.** Change to the Superalgos directory/folder and run this commmand to switch to the develop branch.
```
git checkout develop
```
## Instalation Notes
**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.
**2.** You also need a fork to use the in-app self-update features. These 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.
**2.** You also need a fork to use the in-app self-update 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).
**3.** You are better off running the git clone command as an administrator to avoid permission issues while creating the Superalgos folder and downloading the repository. It may work without admin powers depending on your setup, particularly if you are running the command on a folder where you've got write permissions.
@@ -90,21 +84,21 @@ git checkout develop
![Run the system](https://docs.superalgos.org/images/how-to/run-the-system-01.gif)
**1.** To run the Superalgos client, from inside the Superalgos directory/folder, run this command:
**1.** To run the Superalgos client, go to the Superalgos directory/folder and run this command:
```
node run
```
**2.** The command launches your default browser to load the UI. If Chrome is not your default browser, copy the URL, close the browser, open Chrome, and paste the URL. Be patient... it takes a few seconds to fully load the UI.
**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 only. It may work on other browsers as well — 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 first.
**1.** We are testing the UI on Google Chrome and Safari on macOS only. It may work on other browsers as well — 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.
**TIP:** If your computer has 8 GB of RAM or less, use ```node run minMemo``` to run the system with minimal RAM requirements.
# Uninstall
@@ -116,7 +110,7 @@ Once the app finishes loading, an interactive tutorial takes you by the hand and
![Welcome Tutorial](https://docs.superalgos.org/images/how-to/tutorial-welcome-00.png)
**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 85% of the tutorial. The remaining 15% involves running a live trading session, which requires an account with the exchange. You may learn how to work with other exchanges later on.
**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