Merge pull request #1203 from harrellbm/develop

Pull in changes from Plugin-docs
This commit is contained in:
Luis Fernando Molina authored and GitHub committed 2021-06-23 05:27:03 -04:00
commit 90ffa7b2d1
36 files changed
+7705 -7632

No files matched your search

Binary file not shown.

After

Width:  |  Height:  |  Size: 81 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

@@ -1 +1 @@
{"type":"API Map","name":"CoinGecko","config":"{\n \"codeName\": \"CoinGecko\",\n \"protocol\": \"https\",\n \"portNumber\": \"\",\n \"hostName\": \"api.coingecko.com\",\n \"path\": \"api\",\n \"millisecondsBetweenCalls\": 4000\n}","project":"Foundations","apiVersions":[{"type":"API Version","name":"Version 3","config":"{\n \"codeName\": \"v3\"\n}","project":"Foundations","apiEndpoints":[{"type":"API Endpoint","name":"Coins","config":"{\n \"codeName\": \"coins\"\n}","project":"Foundations","apiQueryParameters":{"type":"API Query Parameters","name":"New API Query Parameters","project":"Foundations","apiQueryParameters":[{"type":"API Query Parameter","name":"Localization Set to False","config":"{\n \"codeName\": \"localization\",\n \"isString\": false,\n \"isOptional\": true,\n \"description\": \"Trim down responce object\",\n \"value\": false\n}","project":"Foundations","id":"24381d43-b7f0-4bbe-b4cb-210c1125db12","savedPayload":{"position":{"x":15254.201694843894,"y":10151.753842330163},"targetPosition":{"x":15301.132034355964,"y":10448.060344508704},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{}}},{"type":"API Query Parameter","name":"Tickers Set to False","config":"{\n \"codeName\": \"tickers\",\n \"isString\": false,\n \"isOptional\": true,\n \"description\": \"Trim down responce object\",\n \"value\": false\n}","project":"Foundations","id":"fdc18d1a-dd75-4d90-905e-25af6d3ddca9","savedPayload":{"position":{"x":15437.329184277827,"y":10180.758387252194},"targetPosition":{"x":15301.132034355964,"y":10448.060344508704},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{}}},{"type":"API Query Parameter","name":"Market Data Set to False","config":"{\n \"codeName\": \"market_data\",\n \"isString\": false,\n \"isOptional\": true,\n \"description\": \"Trim down responce object\",\n \"value\": false\n}","project":"Foundations","id":"ac942e34-b250-4c43-b914-e649059fb4ae","savedPayload":{"position":{"x":15568.433991612474,"y":10311.86319458684},"targetPosition":{"x":15301.132034355964,"y":10448.060344508704},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{}}},{"type":"API Query Parameter","name":"Developer Data Set to False","config":"{\n \"codeName\": \"developer_data\",\n \"isString\": false,\n \"isOptional\": true,\n \"description\": \"Trim down responce object\",\n \"value\": false\n}","project":"Foundations","id":"cca0b1a5-3d80-435a-b7f9-875660d63298","savedPayload":{"position":{"x":15597.438536534504,"y":10494.990684020773},"targetPosition":{"x":15301.132034355964,"y":10448.060344508704},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{}}}],"id":"df0c5b13-4faa-48f4-916f-d429c722dd51","savedPayload":{"position":{"x":15301.132034355964,"y":10448.060344508704},"targetPosition":{"x":15089,"y":10660.192378864667},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false}}},"apiPathParameters":{"type":"API Path Parameters","name":"New API Path Parameters","project":"Foundations","apiPathParameters":[{"type":"API Path Parameter","name":"ID ","config":"{\n \"codeName\": \"currentBaseAsset\",\n \"isString\": true,\n \"isOptional\": false,\n \"description\": \"Get statistics for the current base asset\",\n \"replaceBy\": \"@BaseAssetNameLowercase\"\n}","project":"Foundations","id":"7ad55ecd-aef9-4d5d-847a-76bf95d9dd1e","savedPayload":{"position":{"x":15689,"y":10660.192378864667},"targetPosition":{"x":15389,"y":10660.192378864667},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":1,"distanceToParent":3,"arrangementStyle":0},"uiObject":{}}}],"id":"06767740-6636-4345-aae6-34ff6edd3e6b","savedPayload":{"position":{"x":15389,"y":10660.192378864667},"targetPosition":{"x":15089,"y":10660.192378864667},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false}}},"apiQueryResponses":{"type":"API Query Responses","name":"New API Query Responses","project":"Foundations","apiQueryResponses":[{"type":"API Query Response","name":"200 Successful","config":"{\n \"codeName\": \"200\",\n \"isError\": false\n}","project":"Foundations","apiResponseSchema":{"type":"API Response Schema","name":"New API Response Schema","config":"{\n \"nodePath\": \"apiResponseReceivedObject\"\n}","project":"Foundations","apiResponseFields":{"type":"API Response Field","name":"Root Object","config":"{\n \"codeName\": \"\",\n Line truncated
{"type":"API Map","name":"CoinGecko","config":"{\n \"codeName\": \"CoinGecko\",\n \"protocol\": \"https\",\n \"portNumber\": \"\",\n \"hostName\": \"api.coingecko.com\",\n \"path\": \"api\",\n \"millisecondsBetweenCalls\": 4000\n}","project":"Superalgos","apiVersions":[{"type":"API Version","name":"Version 3","config":"{\n \"codeName\": \"v3\"\n}","project":"Superalgos","apiEndpoints":[{"type":"API Endpoint","name":"Coins","config":"{\n \"codeName\": \"coins\"\n}","project":"Superalgos","apiQueryParameters":{"type":"API Query Parameters","name":"New API Query Parameters","project":"Superalgos","apiQueryParameters":[{"type":"API Query Parameter","name":"Localization Set to False","config":"{\n \"codeName\": \"localization\",\n \"isString\": false,\n \"isOptional\": true,\n \"description\": \"Trim down responce object\",\n \"value\": false\n}","project":"Superalgos","id":"24381d43-b7f0-4bbe-b4cb-210c1125db12","savedPayload":{"position":{"x":15254.201694843894,"y":10151.753842330163},"targetPosition":{"x":15301.132034355964,"y":10448.060344508704},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{}}},{"type":"API Query Parameter","name":"Tickers Set to False","config":"{\n \"codeName\": \"tickers\",\n \"isString\": false,\n \"isOptional\": true,\n \"description\": \"Trim down responce object\",\n \"value\": false\n}","project":"Superalgos","id":"fdc18d1a-dd75-4d90-905e-25af6d3ddca9","savedPayload":{"position":{"x":15437.329184277827,"y":10180.758387252194},"targetPosition":{"x":15301.132034355964,"y":10448.060344508704},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{}}},{"type":"API Query Parameter","name":"Market Data Set to False","config":"{\n \"codeName\": \"market_data\",\n \"isString\": false,\n \"isOptional\": true,\n \"description\": \"Trim down responce object\",\n \"value\": false\n}","project":"Superalgos","id":"ac942e34-b250-4c43-b914-e649059fb4ae","savedPayload":{"position":{"x":15568.433991612474,"y":10311.86319458684},"targetPosition":{"x":15301.132034355964,"y":10448.060344508704},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{}}},{"type":"API Query Parameter","name":"Developer Data Set to False","config":"{\n \"codeName\": \"developer_data\",\n \"isString\": false,\n \"isOptional\": true,\n \"description\": \"Trim down responce object\",\n \"value\": false\n}","project":"Superalgos","id":"cca0b1a5-3d80-435a-b7f9-875660d63298","savedPayload":{"position":{"x":15597.438536534504,"y":10494.990684020773},"targetPosition":{"x":15301.132034355964,"y":10448.060344508704},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{}}}],"id":"df0c5b13-4faa-48f4-916f-d429c722dd51","savedPayload":{"position":{"x":15301.132034355964,"y":10448.060344508704},"targetPosition":{"x":15089,"y":10660.192378864667},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":true,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false}}},"apiPathParameters":{"type":"API Path Parameters","name":"New API Path Parameters","project":"Superalgos","apiPathParameters":[{"type":"API Path Parameter","name":"ID ","config":"{\n \"codeName\": \"currentBaseAsset\",\n \"isString\": true,\n \"isOptional\": false,\n \"description\": \"Get statistics for the current base asset\",\n \"replaceBy\": \"@BaseAssetNameLowercase\"\n}","project":"Superalgos","id":"7ad55ecd-aef9-4d5d-847a-76bf95d9dd1e","savedPayload":{"position":{"x":15689,"y":10660.192378864667},"targetPosition":{"x":15389,"y":10660.192378864667},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":1,"distanceToParent":3,"arrangementStyle":0},"uiObject":{}}}],"id":"06767740-6636-4345-aae6-34ff6edd3e6b","savedPayload":{"position":{"x":15389,"y":10660.192378864667},"targetPosition":{"x":15089,"y":10660.192378864667},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":true,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false}}},"apiQueryResponses":{"type":"API Query Responses","name":"New API Query Responses","project":"Superalgos","apiQueryResponses":[{"type":"API Query Response","name":"200 Successful","config":"{\n \"codeName\": \"200\",\n \"isError\": false\n}","project":"Superalgos","apiResponseSchema":{"type":"API Response Schema","name":"New API Response Schema","config":"{\n \"nodePath\": \"apiResponseReceivedObject\"\n}","project":"Superalgos","apiResponseFields":{"type":"API Response Field","name":"Root Object","config":"{\n \"codeName\": \"\",\n \"fieldType\Line truncated
@@ -1 +1 @@
{"type":"API Map","name":"Messari","config":"{\n \"codeName\": \"Messari\",\n \"protocol\": \"https\",\n \"hostName\": \"data.messari.io\",\n \"portNumber\": \"\",\n \"path\": \"api\",\n \"millisecondsBetweenCalls\": 4000\n}","project":"Foundations","apiVersions":[{"type":"API Version","name":"Version 1","config":"{\n \"codeName\": \"v1\"\n}","project":"Foundations","apiEndpoints":[{"type":"API Endpoint","name":"Get All News","config":"{\n \"codeName\": \"news\"\n}","project":"Foundations","apiQueryParameters":{"type":"API Query Parameters","name":"New API Query Parameters","config":"{\n \"codeName\": \"\"\n}","project":"Foundations","apiQueryParameters":[{"type":"API Query Parameter","name":"Page","config":"{\n \"codeName\": \"page\",\n \"isString\": false,\n \"isOptional\": false,\n \"description\": \"Page number, starts at 1. Increment to paginate through results (until result is empty array)\",\n \"isPageNumber\": true\n}","project":"Foundations","id":"754e2724-36bc-4e4e-94cf-bfba88dadd3b","savedPayload":{"position":{"x":14012.485238430854,"y":10170.798147156756},"targetPosition":{"x":14302.262986317575,"y":10248.443860687512},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{}}},{"type":"API Query Parameter","name":"Fields","config":"{\n \"codeName\": \"fields\",\n \"isString\": true,\n \"isOptional\": true,\n \"description\": \"pare down the returned fields (comma , separated, drill down with a slash /)\"\n}","project":"Foundations","id":"3199c37c-5ecc-47fd-8868-eddaa15fdc59","savedPayload":{"position":{"x":14152.262986317575,"y":9988.636239552181},"targetPosition":{"x":14302.262986317575,"y":10248.443860687512},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{}}},{"type":"API Query Parameter","name":"As Markdown","config":"{\n \"codeName\": \"as-markdown\",\n \"isString\": false,\n \"isOptional\": true,\n \"description\": \"formatting (other than HTML links) is hidden. Use this query param to return content with markdown syntax\"\n}","project":"Foundations","id":"fa87b1ad-2d0f-4462-85fb-524630e9db7a","savedPayload":{"position":{"x":14379.90869984833,"y":9958.66611280079},"targetPosition":{"x":14302.262986317575,"y":10248.443860687512},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{}}}],"id":"03f8b00d-10cf-423d-a654-d8db598c76a9","savedPayload":{"position":{"x":14302.262986317575,"y":10248.443860687512},"targetPosition":{"x":14452.262986317575,"y":10508.251481822843},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":1,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false}}},"apiQueryResponses":{"type":"API Query Responses","name":"New API Query Responses","config":"{\n \"codeName\": \"\"\n}","project":"Foundations","apiQueryResponses":[{"type":"API Query Response","name":"200 Successful","config":"{\n \"codeName\": \"200\"\n}","project":"Foundations","apiResponseSchema":{"type":"API Response Schema","name":"New API Response Schema","config":"{\n \"nodePath\": \"apiResponseReceivedObject.data\"\n}","project":"Foundations","apiResponseFields":{"type":"API Response Field","name":"Root Object","config":"{\n \"codeName\": \"Root-Object\",\n \"fieldType\": \"object\",\n \"descrption\": \"This is the root object of the API response.\"\n}","project":"Foundations","apiResponseFields":[{"type":"API Response Field","name":"Status","config":"{\n \"codeName\": \"status\",\n \"fieldType\": \"object\",\n \"descrption\": \"object (ApiStatus)\"\n}","project":"Foundations","apiResponseFields":[{"type":"API Response Field","name":"Enlapsed","config":"{\n \"codeName\": \"enlapsed\",\n \"fieldType\": \"number\",\n \"descrption\": \"\"\n}","project":"Foundations","apiResponseFields":[],"id":"9c472348-ac24-4567-a36f-8600a1fac914","savedPayload":{"position":{"x":14951.343306028359,"y":9150.346729261515},"targetPosition":{"x":15120.339323447446,"y":9398.218361556314},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false}}},{"type":"API Response Field","name":"Timestamp","config":"{\n \"codeName\": \"timestamp\",\n \"fieldType\": \"date\",\n \"descrption\": \"\"\n}","project":"Foundations","apiResponseFields":[],"id":"12b796fd-85eb-49b2-a88e-b400f52cc5e9","savedPayload":{"position":{"x":15250.504445182713,"y":9127.927701185588},"targetPosition":{"x":15120.339323447446,"y":9398.218361556314},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false}}}],"id":"5d45e7d6-8Line truncated
{"type":"API Map","name":"Messari","config":"{\n \"codeName\": \"Messari\",\n \"protocol\": \"https\",\n \"hostName\": \"data.messari.io\",\n \"portNumber\": \"\",\n \"path\": \"api\",\n \"millisecondsBetweenCalls\": 4000\n}","project":"Superalgos","apiVersions":[{"type":"API Version","name":"Version 1","config":"{\n \"codeName\": \"v1\"\n}","project":"Superalgos","apiEndpoints":[{"type":"API Endpoint","name":"Get All News","config":"{\n \"codeName\": \"news\"\n}","project":"Superalgos","apiQueryParameters":{"type":"API Query Parameters","name":"New API Query Parameters","config":"{\n \"codeName\": \"\"\n}","project":"Superalgos","apiQueryParameters":[{"type":"API Query Parameter","name":"Page","config":"{\n \"codeName\": \"page\",\n \"isString\": false,\n \"isOptional\": false,\n \"description\": \"Page number, starts at 1. Increment to paginate through results (until result is empty array)\",\n \"isPageNumber\": true\n}","project":"Superalgos","id":"203cbc28-391c-40a1-98e1-cc596ed235d6","savedPayload":{"position":{"x":11618.6256524224,"y":18293.39693893542},"targetPosition":{"x":11908.403400309122,"y":18371.042652466178},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{}}},{"type":"API Query Parameter","name":"Fields","config":"{\n \"codeName\": \"fields\",\n \"isString\": true,\n \"isOptional\": true,\n \"description\": \"pare down the returned fields (comma , separated, drill down with a slash /)\"\n}","project":"Superalgos","id":"1b9a0669-814f-46b9-be4b-740e49ede59a","savedPayload":{"position":{"x":11758.403400309122,"y":18111.235031330845},"targetPosition":{"x":11908.403400309122,"y":18371.042652466178},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{}}},{"type":"API Query Parameter","name":"As Markdown","config":"{\n \"codeName\": \"as-markdown\",\n \"isString\": false,\n \"isOptional\": true,\n \"description\": \"formatting (other than HTML links) is hidden. Use this query param to return content with markdown syntax\"\n}","project":"Superalgos","id":"a36171c1-3695-4423-b36a-d2f92c6a67e9","savedPayload":{"position":{"x":11986.049113839877,"y":18081.264904579457},"targetPosition":{"x":11908.403400309122,"y":18371.042652466178},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{}}}],"id":"521305b8-5f75-41ec-86c7-f2eadecdf6ac","savedPayload":{"position":{"x":12058.403400309122,"y":18330.85027360151},"targetPosition":{"x":12058.403400309122,"y":18630.85027360151},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":true,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false}}},"apiQueryResponses":{"type":"API Query Responses","name":"New API Query Responses","config":"{\n \"codeName\": \"\"\n}","project":"Superalgos","apiQueryResponses":[{"type":"API Query Response","name":"200 Successful","config":"{\n \"codeName\": \"200\"\n}","project":"Superalgos","apiResponseSchema":{"type":"API Response Schema","name":"New API Response Schema","config":"{\n \"nodePath\": \"apiResponseReceivedObject.data\"\n}","project":"Superalgos","apiResponseFields":{"type":"API Response Field","name":"Root Object","config":"{\n \"codeName\": \"Root-Object\",\n \"fieldType\": \"object\",\n \"descrption\": \"This is the root object of the API response.\"\n}","project":"Superalgos","apiResponseFields":[{"type":"API Response Field","name":"Status","config":"{\n \"codeName\": \"status\",\n \"fieldType\": \"object\",\n \"descrption\": \"object (ApiStatus)\"\n}","project":"Superalgos","apiResponseFields":[{"type":"API Response Field","name":"Enlapsed","config":"{\n \"codeName\": \"enlapsed\",\n \"fieldType\": \"number\",\n \"descrption\": \"\"\n}","project":"Superalgos","apiResponseFields":[],"id":"0fb48f72-65e6-4c6e-abf2-5d2163fe100f","savedPayload":{"position":{"x":12557.483720019905,"y":17272.945521040176},"targetPosition":{"x":12726.479737438993,"y":17520.817153334974},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false}}},{"type":"API Response Field","name":"Timestamp","config":"{\n \"codeName\": \"timestamp\",\n \"fieldType\": \"date\",\n \"descrption\": \"\"\n}","project":"Superalgos","apiResponseFields":[],"id":"f8a89ef2-c531-439f-8b5c-c31a0572b30b","savedPayload":{"position":{"x":12856.64485917426,"y":17250.526492964247},"targetPosition":{"x":12726.479737438993,"y":17520.817153334974},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false}}}],"id":"df145442-e84b-4f70-97eeLine truncated
File diff suppressed because it is too large. Load diff
@@ -0,0 +1,54 @@
{
"topic": "Debugging Your Indicator",
"pageNumber": 1,
"type": "Debugging - Download and Install Visual Studio Code",
"definition": {
"text": "This process details how to use an Integrated Development Environment (IDE) to identify and fix bugs in the Superalgos code and help contribute! ",
"updated": 1623400412309
},
"paragraphs": [
{
"style": "Note",
"text": "For the following steps, we are going to show the concept of debugging using Visual Studio Code. You may use any other Integrated Development Environment (IDE) that you feel comfortable with. ",
"updated": 1623400449204
},
{
"style": "Subtitle",
"text": "<hr>",
"updated": 1614264382973
},
{
"style": "Subtitle",
"text": "\"Our greatest weakness lies in giving up. The most certain way to succeed is always to try just one more time.\" -Thomas Edison"
},
{
"style": "Subtitle",
"text": "<hr>"
},
{
"style": "Text",
"text": "So, you've run into issues creating an indicator, seen an error in the console or have encountered a Task that just won't run. Grab some coffee and mosquito repellent - we're going bug hunting!",
"updated": 1623400585649
},
{
"style": "Text",
"text": "The first step is to download Microsoft Visual Studio Code, this is available for free at the link below:",
"updated": 1623401539321
},
{
"style": "Link",
"text": "Download Microsoft Visual Studio Code->code.visualstudio.com/download",
"updated": 1623401422825
},
{
"style": "Png",
"text": "PNGs/Superalgos/Docs/debugging-your-indicator/0_download-visual-studio.png",
"updated": 1623414213827
},
{
"style": "Text",
"text": "After you've installed Visual Studio Code, click Next to go through the process of configuring it so that you can access the Superalgos directory.",
"updated": 1623407789702
}
]
}
@@ -1,50 +0,0 @@
{
"topic": "Debugging Your Indicator",
"pageNumber": "1",
"type": "Debugging - First Step",
"definition": {
"text": "Using an Integrated development environment (IDE) will help you catch bugs.",
"updated": 1614257102916,
"translations": [
{
"language": "CN",
"text": "Using an Integrated development environment (IDE) will help you catch bugs. ",
"updated": 1614338765880,
"style": "Definition"
}
]
},
"paragraphs": [
{
"style": "Note",
"text": "For the following steps, we are going to show the concept of debugging using Visual Studio Code. You may use any other Integrated development environment (IDE) that you feel comfortable with.",
"updated": 1614264361700
},
{
"style": "Subtitle",
"text": "<hr>",
"updated": 1614264382973
},
{
"style": "Subtitle",
"text": "\"Our greatest weakness lies in giving up. The most certain way to succeed is always to try just one more time.\" -Thomas Edison"
},
{
"style": "Subtitle",
"text": "<hr>"
},
{
"style": "Text",
"text": "So, you've come up with your new indicator idea, jotted down the outlines, translated it into code - Perfect!...then it stops with an error.",
"updated": 1614257276497
},
{
"style": "Text",
"text": "Grab some coffee and mosquito repellent - We're going bug hunting."
},
{
"style": "Text",
"text": "<a href=\"https://visualstudio.microsoft.com/free-developer-offers/\" target=\"_blank\">Get Visual Studio Code</a>"
}
]
}
@@ -1,10 +1,10 @@
{
"topic": "Debugging Your Indicator",
"pageNumber": "2",
"pageNumber": 2,
"type": "Debugging - Setting up your IDE",
"definition": {
"text": "Toggling Breakpoints is telling the program where to slow down - Where we'd like to take control",
"updated": 1614511933639,
"text": "The first step is to set up Visual Studio Code so that it has access to the Superalgos directory and that it knows what file to run, attach to and monitor for debugging.",
"updated": 1623402147604,
"translations": [
{
"language": "CN",
@@ -16,68 +16,104 @@
},
"paragraphs": [
{
"style": "Text",
"text": "Start up your IDE and Add the \"TaskServer\" folder (../Superalgos/TaskServer) to your workspace.",
"updated": 1614331592978
},
{
"style": "Png",
"text": "PNGs/Foundations/Docs/debugging-your-indicator/1_open-folder.png",
"updated": 1614329413344
},
{
"style": "Png",
"text": "PNGs/Foundations/Docs/debugging-your-indicator/2_taskserver-folder.png",
"updated": 1614331239911
"style": "Title",
"text": "Overview",
"updated": 1623402158529
},
{
"style": "Text",
"text": "Also Add the \"Projects\" (../Superalgos/Projects) folder to your workspace.",
"updated": 1614331619021
"text": "Superalgos has three core components, the Client, TS and the UI.",
"updated": 1623402455917
},
{
"style": "Png",
"text": "PNGs/Foundations/Docs/debugging-your-indicator/3_add-folder.png",
"updated": 1614331194799
},
{
"style": "Png",
"text": "PNGs/Foundations/Docs/debugging-your-indicator/4_projects-folder.png",
"updated": 1614331302498
"style": "Success",
"text": "Hover over (or click) each word above above to learn more regarding each component.",
"updated": 1623402349861
},
{
"style": "Text",
"text": "Locate and open the file \"SingleMarketFunctions.js\" (..Superalgos\\Projects\\Foundations\\TS\\Function-Libraries\\SingleMarketFunctions.js)."
"text": "For debugging purposes we already want to have the Client and UI running. This process details how to set up Visual Studio Code to run a debug instance of the TS.",
"updated": 1623404705493
},
{
"style": "Text",
"text": "First we need to set up our Visual Studio Code workspace so we can see the Superalgos directory.",
"updated": 1623404725437
},
{
"style": "Title",
"text": "Configuring Visual Studio Code",
"updated": 1623402750807
},
{
"style": "Text",
"text": "Start up Visual Studio Code and click on the Explorer icon to open the Explorer left hand panel."
},
{
"style": "Png",
"text": "PNGs/Foundations/Docs/debugging-your-indicator/5_locate-singlemarket-in-tree.png"
"text": "PNGs/Superalgos/Docs/debugging-your-indicator/1_open-explorer.png",
"updated": 1623407107099
},
{
"style": "Text",
"text": "Now we will have to find the line in the code where we'd like the process to stop, and show us what's really happening.",
"updated": 1614331648050
"text": "As we are just running the TS in debug mode, we start with the \"TaskServer\" folder.",
"updated": 1623404758089
},
{
"style": "Text",
"text": "Click on the Add Folder button and open the \"TaskServer\" folder (../Superalgos/TaskServer) to add this to your Visual Studio Code workspace."
},
{
"style": "Png",
"text": "PNGs/Foundations/Docs/debugging-your-indicator/6_find-line-for-breakpoint.png"
"text": "PNGs/Superalgos/Docs/debugging-your-indicator/2_open-folder.png",
"updated": 1623407112534
},
{
"style": "Png",
"text": "PNGs/Superalgos/Docs/debugging-your-indicator/3_taskserver-folder.png",
"updated": 1623407118113
},
{
"style": "Text",
"text": "This point would be the line that says:"
},
{
"style": "Javascript",
"text": "\"eval(dataBuildingProcedure.loop.procedureJavascriptCode.code)\""
"text": "Next we add the \"Projects\" folder so that we can analyse the rest of the Superalgos files.",
"updated": 1623405000959
},
{
"style": "Text",
"text": "Insert a breakpoint (F9) at this line."
"text": "Right-click in the empty space of the Explorer left-hand panel and click on Add Folder to Workspace and also add the \"Projects\" (../Superalgos/Projects) folder to your workspace."
},
{
"style": "Note",
"text": "Using \"CTRL+F\" allows us to find what we search for in the code.",
"updated": 1614265550399
"style": "Png",
"text": "PNGs/Superalgos/Docs/debugging-your-indicator/4_add-folder.png",
"updated": 1623407412773
},
{
"style": "Png",
"text": "PNGs/Superalgos/Docs/debugging-your-indicator/5_projects-folder.png",
"updated": 1623407419399
},
{
"style": "Text",
"text": "The Explorer left-hand panel should now have the two folders \"TaskServer\" and \"Projects\" like below.",
"updated": 1623408055408
},
{
"style": "Png",
"text": "PNGs/Superalgos/Docs/debugging-your-indicator/6_explorer-folders.png",
"updated": 1623408036777
},
{
"style": "Text",
"text": "If this matches let's save our Workspace so the next time we open Visual Studio Code this loads automatically. Click on File then Save Workspace As and give it a name.",
"updated": 1623408092688
},
{
"style": "Png",
"text": "PNGs/Superalgos/Docs/debugging-your-indicator/7_save-workspace.png"
},
{
"style": "Text",
"text": "Awesome! That's all there is to setting up Visual Studio Code so it can access the Superalgos directory. Next we are going to dive into the code and talk about breakpoints."
}
]
}
@@ -0,0 +1,65 @@
{
"topic": "Debugging Your Indicator",
"pageNumber": 3,
"type": "Debugging - Setting a Breakpoint",
"definition": {
"text": "A breakpoint is a user defined place in the code where the debugger will pause and allow you to examine the state of affairs! This means you can analyse the current state of variables and inputs and outputs of functions to help try determine where the cause of a problem might be.",
"updated": 1623408792317
},
"paragraphs": [
{
"style": "Text",
"text": "For this example we are going to be debugging an indicator, therefore we expand into the Projects folder and find the file with the code which builds indicators. In this file we will place a breakpoint.",
"updated": 1623405682457
},
{
"style": "Success",
"text": "A breakpoint is an intentional stopping or pausing place in a program, put in place for debugging purposes. It's where the code execution pauses and you can check on the status of things!",
"updated": 1623405106048
},
{
"style": "Text",
"text": ""
},
{
"style": "Text",
"text": "Expand the Projects folder and open the file \"SingleMarketFunctions.js\" (..Superalgos/Projects/Superalgos/TS/Function-Libraries/SingleMarketFunctions.js).",
"updated": 1623414479019
},
{
"style": "Png",
"text": "PNGs/Superalgos/Docs/debugging-your-indicator/8_locate-singlemarket-in-tree.png",
"updated": 1623409023676
},
{
"style": "Text",
"text": "Now we will have to find the line in the code where we'd like the process to pause, and show us what's really happening. This point would be the line that says:",
"updated": 1623405827603
},
{
"style": "Javascript",
"text": "eval(dataBuildingProcedure.loop.procedureJavascriptCode.code)",
"updated": 1623409950310
},
{
"style": "Png",
"text": "PNGs/Superalgos/Docs/debugging-your-indicator/9_find-line-for-breakpoint.png",
"updated": 1623409045497
},
{
"style": "Text",
"text": "Click just to the left of the line number, or press F9 to insert a breakpoint at this line.",
"updated": 1623405851133
},
{
"style": "Note",
"text": "Using \"CTRL+F\" allows us to find what we search for in the code.",
"updated": 1614265550399
},
{
"style": "Text",
"text": "Now we have a breakpoint configured, we can try running a Task. Click Next to go through the process of how to start the TS and trigger your breakpoint.",
"updated": 1623409257540
}
]
}
@@ -1,91 +0,0 @@
{
"topic": "Debugging Your Indicator",
"pageNumber": "3",
"type": "Debugging - Start Your Processes",
"definition": {
"text": "Start the Task in Debug mode while running a debug session in your IDE.",
"updated": 1614332155989,
"translations": [
{
"language": "CN",
"text": "Start the Task in Debug mode while running a debug session in your IDE. ",
"updated": 1614338791705,
"style": "Definition"
}
]
},
"paragraphs": [
{
"style": "Text",
"text": "Start your Superalgos UI by going to the terminal and enter \"node run\".",
"updated": 1614332264940
},
{
"style": "Png",
"text": "PNGs/Foundations/Docs/debugging-your-indicator/8_node-run.png"
},
{
"style": "Text",
"text": "Start a Debug Session in your IDE by clicking \"Run -> Start Debugging\" (F5)",
"updated": 1614332454563
},
{
"style": "Png",
"text": "PNGs/Foundations/Docs/debugging-your-indicator/9_start-debugging.png"
},
{
"style": "Text",
"text": "Go to your Network node and find the Data Task for your indicator.",
"updated": 1614332492978
},
{
"style": "Png",
"text": "PNGs/Foundations/Docs/debugging-your-indicator/10_network.png"
},
{
"style": "Text",
"text": "Expand the Data Tasks and hover over the Task node for your indicator and click \"Debug\" (the Task will start up, but in Debug mode).",
"updated": 1614332581381
},
{
"style": "Png",
"text": "PNGs/Foundations/Docs/debugging-your-indicator/11_expand-data-tasks.png"
},
{
"style": "Png",
"text": "PNGs/Foundations/Docs/debugging-your-indicator/12_debug-your-indicator-task.png",
"updated": 1614332699707
},
{
"style": "Png",
"text": "PNGs/Foundations/Docs/debugging-your-indicator/13_check-your-indicator-starts.png"
},
{
"style": "Text",
"text": "Start the needed tasks connected to your indicator (i.e.: Exchange Raw Data and Candle Volumes) by hovering over the nodes and click \"Run\".",
"updated": 1614512004319
},
{
"style": "Png",
"text": "PNGs/Foundations/Docs/debugging-your-indicator/15_run-ohlcvs.png"
},
{
"style": "Png",
"text": "PNGs/Foundations/Docs/debugging-your-indicator/16_run-dependencies.png"
},
{
"style": "Png",
"text": "PNGs/Foundations/Docs/debugging-your-indicator/14_check-debug-terminal.png"
},
{
"style": "Note",
"text": "Check your Superalgos terminal to see if everything starts up as planned.",
"updated": 1614512021346
},
{
"style": "Note",
"text": "Deleting existing data from your indicator in the..Superalgos/Data-Storage/ folder might speed up the data mining process.",
"updated": 1614512028147
}
]
}
@@ -0,0 +1,131 @@
{
"topic": "Debugging Your Indicator",
"pageNumber": 4,
"type": "Debugging - Start Your Processes",
"definition": {
"text": "Now we have a breakpoint configured we can start the TS in Visual Studio Code. Then in the Superalgos UI we can find a Task and start this using Debug mode.",
"updated": 1623409454402,
"translations": [
{
"language": "CN",
"text": "Start the Task in Debug mode while running a debug session in your IDE. ",
"updated": 1614338791705,
"style": "Definition"
}
]
},
"paragraphs": [
{
"style": "Text",
"text": "As we covered before there are three core components to Superalgos, the Client, TS and UI. ",
"updated": 1623409529218
},
{
"style": "Text",
"text": "First, we need to make sure the Client and UI are running. If they are not already running, you can start the UI by going to the terminal, ensuring you are in the Superalgos root directory and enter \"node run\".",
"updated": 1623409611552
},
{
"style": "Success",
"text": "If the Terminal is not visible click on View -> Terminal and it should appear at the bottom.",
"updated": 1623410067613
},
{
"style": "Note",
"text": "If needed you can run this with any parameters like \"node run minMemo noBrowser\" as required."
},
{
"style": "Png",
"text": "PNGs/Superalgos/Docs/debugging-your-indicator/10_node-run.png",
"updated": 1623409808656
},
{
"style": "Text",
"text": "At this stage you should be able to access Superalgos in the browser using http://localhost:34248/ (or the particular hostname and port you use).",
"updated": 1623409750881
},
{
"style": "Text",
"text": "Next we are going to start the TS in debug mode. To do this start a Debug Session in Visual Studio Code by clicking \"Run -> Start Debugging\" F5",
"updated": 1623410434222
},
{
"style": "Png",
"text": "PNGs/Superalgos/Docs/debugging-your-indicator/11_start-debugging.png",
"updated": 1623409861513
},
{
"style": "Text",
"text": "To confirm the TS is running, you can click on the Run and Debug icon which will open a new left-hand panel. In here under the Call Stack you should be able to see the TaskServer running.",
"updated": 1623410288365
},
{
"style": "Png",
"text": "PNGs/Superalgos/Docs/debugging-your-indicator/12_run-and-debug.png"
},
{
"style": "Text",
"text": "Now the TS is running we can start a Task via the Debug action.",
"updated": 1623410467602
},
{
"style": "Text",
"text": "Go to your Network node and find the Data Task for your indicator."
},
{
"style": "Png",
"text": "PNGs/Superalgos/Docs/debugging-your-indicator/13_network.png",
"updated": 1623410476464
},
{
"style": "Text",
"text": "Expand the Data Tasks and hover over the Task node for your indicator and click \"Debug\" (the Task will start up, but in Debug mode).",
"updated": 1614332581381
},
{
"style": "Important",
"text": "If you receive an error stating \"Parent Task Not Running\" this can be ignored. As we are using the Debug action the task will start anyway.",
"updated": 1623410561295
},
{
"style": "Png",
"text": "PNGs/Superalgos/Docs/debugging-your-indicator/14_expand-data-tasks.png",
"updated": 1623410569919
},
{
"style": "Png",
"text": "PNGs/Superalgos/Docs/debugging-your-indicator/15_debug-your-indicator-task.png",
"updated": 1623410589000
},
{
"style": "Text",
"text": "If your Task has dependencies (for example above we are debugging Resistances and Supports, but these need the Exchange Raw Data and Candles running before they will run) start the needed tasks connected to your indicator by hovering over the nodes and click \"Run\".",
"updated": 1623410869266
},
{
"style": "Png",
"text": "PNGs/Superalgos/Docs/debugging-your-indicator/16_run-ohlcvs.png",
"updated": 1623411034335
},
{
"style": "Png",
"text": "PNGs/Superalgos/Docs/debugging-your-indicator/17_run-dependencies.png",
"updated": 1623411039717
},
{
"style": "Text",
"text": "If you have a look in the Debug Code terminal you should now see your indicator running as normal.",
"updated": 1623410912711
},
{
"style": "Png",
"text": "PNGs/Superalgos/Docs/debugging-your-indicator/18_check-debug-terminal.png",
"updated": 1623411066811
},
{
"style": "Note",
"text": "Deleting existing data from your indicator in the ..Superalgos/Data-Storage/ folder might speed up the data mining process.",
"updated": 1623410940602
}
]
}
@@ -1,6 +1,6 @@
{
"topic": "Debugging Your Indicator",
"pageNumber": "4",
"pageNumber": 5,
"type": "Debugging - Let The Hunt Begin!",
"definition": {
"text": "Use F11 to zoom in to the code once it stops at the breaking point, and use F5 to take it step by step forward.",
@@ -40,11 +40,13 @@
},
{
"style": "Png",
"text": "PNGs/Foundations/Docs/debugging-your-indicator/7_breaking-point-indication.png"
"text": "PNGs/Superalgos/Docs/debugging-your-indicator/19_breaking-point-indication.png",
"updated": 1623411413725
},
{
"style": "Png",
"text": "PNGs/Foundations/Docs/debugging-your-indicator/17_stopped-at-breaking-point.png"
"text": "PNGs/Superalgos/Docs/debugging-your-indicator/20_stopped-at-breaking-point.png",
"updated": 1623411419203
},
{
"style": "Text",
@@ -60,7 +62,8 @@
},
{
"style": "Png",
"text": "PNGs/Foundations/Docs/debugging-your-indicator/18_zoomed-in-getting-values.png"
"text": "PNGs/Superalgos/Docs/debugging-your-indicator/21_zoomed-in-getting-values.png",
"updated": 1623411423507
},
{
"style": "Note",
@@ -1,7 +1,7 @@
{
"topic": "Debugging Your Indicator",
"pageNumber": "5",
"type": "Debugging - Found something!",
"pageNumber": 6,
"type": "Debugging - Found Something!",
"definition": {
"text": "Rinse and repeat.",
"updated": 1614512264174,
+23 -2
View File
@@ -1,5 +1,10 @@
# Superalgos Beta 10
![contributors](https://img.shields.io/github/contributors-anon/Superalgos/Superalgos?label=Contributors)
![commit-activity](https://img.shields.io/github/commit-activity/y/Superalgos/Superalgos?label=Commit%20Activity)
![bot-friendliness](https://img.shields.io/badge/Bot%20Friendliness%20Level-119%25-yellow)
Superalgos is not just another open-source project. We are an open and welcoming community devised, nurtured, and incentivized with the project's native <a href="https://superalgos.org/token-overview.shtml" target="_blank">Superalgos (SA) token</a> to grow into a massive trading collaboration. You will notice the difference as soon as you join the [Telegram Community Group](https://t.me/superalgoscommunity) or the new [Discord Server](https://discord.gg/CGeKC6WQQb).
Superalgos is the ultimate market research and trading automation platform. The software is contributor-centric, built by contributors, for contributors. It is also free and open-source.
@@ -126,8 +131,6 @@ This creates the `Superalgos` folder in the current directory, which contains th
## 3. Install Node Dependencies
**IMPORTANT:** 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.
**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:
@@ -158,6 +161,24 @@ 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.