Added endpoints, Added postman docs, Fixed bugs and more!

.eslintrc.json

@@ -0,0 +1,139 @@
+{
+  "parserOptions": {
+    "ecmaVersion": 9
+  },
+  "ignorePatterns": ["**/sdk/**", "**/gitlab-ci/**"],
+  "extends": ["prettier"],
+  "plugins": ["prettier"],
+  "env": {
+    "node": true,
+    "jest": true
+  },
+  "rules": {
+    "comma-dangle": ["error", "never"],
+    "no-cond-assign": 2,
+    "no-constant-condition": 2,
+    "no-control-regex": 2,
+    "no-debugger": 2,
+    "no-dupe-args": 2,
+    "no-dupe-keys": 2,
+    "no-duplicate-case": 2,
+    "no-empty-character-class": 2,
+    "no-extra-semi": 2,
+    "no-func-assign": 2,
+    "no-invalid-regexp": 2,
+    "no-irregular-whitespace": 2,
+    "no-negated-in-lhs": 2,
+    "no-obj-calls": 2,
+    "no-unreachable": 2,
+    "use-isnan": 2,
+    "no-unexpected-multiline": 2,
+    "curly": 2,
+    "dot-location": [2, "property"],
+    "no-alert": 2,
+    "no-caller": 1,
+    "no-eval": 1,
+    "no-multi-spaces": 2,
+    "no-unused-vars": [
+      2,
+      {
+        "vars": "all",
+        "args": "none"
+      }
+    ],
+    "array-bracket-spacing": [2, "never"],
+    "block-spacing": [2, "never"],
+    "brace-style": [
+      2,
+      "1tbs",
+      {
+        "allowSingleLine": true
+      }
+    ],
+    "camelcase": [
+      "error",
+      {
+        "properties": "never"
+      }
+    ],
+    "comma-spacing": [
+      2,
+      {
+        "before": false,
+        "after": true
+      }
+    ],
+    "comma-style": [2, "last"],
+    "computed-property-spacing": [2, "never"],
+    "consistent-this": [2, "self"],
+    "eol-last": 2,
+    "func-style": [2, "declaration", { "allowArrowFunctions": true }],
+    "indent": [
+      2,
+      2,
+      {
+        "SwitchCase": 1
+      }
+    ],
+    "key-spacing": [
+      2,
+      {
+        "beforeColon": false,
+        "afterColon": true
+      }
+    ],
+    "keyword-spacing": 2,
+    "lines-around-comment": [
+      2,
+      {
+        "beforeBlockComment": true,
+        "beforeLineComment": false,
+        "allowBlockStart": true
+      }
+    ],
+    "linebreak-style": [2, "unix"],
+    "new-cap": 2,
+    "new-parens": 2,
+    "newline-after-var": [2, "always"],
+    "no-array-constructor": 2,
+    "no-inline-comments": 2,
+    "no-lonely-if": 2,
+    "no-mixed-spaces-and-tabs": 2,
+    "no-multiple-empty-lines": [
+      2,
+      {
+        "max": 1
+      }
+    ],
+    "no-nested-ternary": 0,
+    "no-new-object": 2,
+    "no-spaced-func": 2,
+    "no-trailing-spaces": 2,
+    "object-curly-spacing": [2, "always"],
+    "one-var": [2, "never"],
+    "operator-linebreak": [2, "after"],
+    "quote-props": [2, "as-needed"],
+    "quotes": [2, "single", "avoid-escape"],
+    "semi-spacing": 2,
+    "semi": [2, "always"],
+    "sort-vars": 2,
+    "space-before-blocks": 2,
+    "space-before-function-paren": [
+      2,
+      {
+        "anonymous": "never",
+        "named": "never",
+        "asyncArrow": "always"
+      }
+    ],
+    "space-in-parens": [2, "never"],
+    "space-infix-ops": 2,
+    "space-unary-ops": [
+      2,
+      {
+        "words": true,
+        "nonwords": false
+      }
+    ]
+  }
+}

.gitignore

@@ -1,3 +1,5 @@
 package-lock.json
 node_modules
 .DS_Store
+!test/sky-puppy-config.json
+sky-puppy-config.json

.prettierrc.js

@@ -0,0 +1,4 @@
+module.exports = {
+  tabWidth: 2,
+  singleQuote: true,
+};

README.nbs

@@ -1,5 +1,124 @@
 # Sky Puppy
-A easy to use reliable health checking service with Prometheus export
+A easy to use reliable endpoint coordinator / health checking service with Prometheus export
 
+[Sky Puppy Postman Collection](https://documenter.getpostman.com/view/208035/TVYKawgU)
+
+## Install
+
+```bash
+npm install -g sky-puppy
+```
+
+## Run
+
+```bash
+sky-puppy
+```
+
+## Sample Config
+
+Sky Puppy looks for a file called `sky-puppy-config.json` in the folder it is ran at.
+
+```json
+{
+  "alerters": {
+    "discord_down": {
+      "uri": "http://discord.com",
+      "json": true,
+      "method": "PUT",
+      "body": {
+        "embeds": [
+          {
+            "title": "{{service_name}} is {{alert_type}}!",
+            "description": "This service was healthy for {{last_healthy_total_duration}} seconds!",
+            "color": 14828098,
+            "footer": {
+              "text": ""
+            },
+            "timestamp": "{{timestamp}}"
+          }
+        ],
+        "username": "Sky Puppy",
+        "avatar_url": "https://i.imgur.com/J5vIVSt.png"
+      }
+    },
+    "discord_unhealthy": {
+      "uri": "http://discord.com",
+      "json": true,
+      "method": "PUT",
+      "body": {
+        "embeds": [
+          {
+            "title": "{{service_name}} is {{alert_type}}!",
+            "description": "This service was healthy for {{last_healthy_total_duration}} seconds!",
+            "color": 14852674,
+            "footer": {
+              "text": ""
+            },
+            "timestamp": "{{timestamp}}"
+          }
+        ],
+        "username": "Sky Puppy",
+        "avatar_url": "https://i.imgur.com/J5vIVSt.png"
+      }
+    },
+    "discord_healthy": {
+      "uri": "http://discord.com",
+      "json": true,
+      "method": "PUT",
+      "body": {
+        "embeds": [
+          {
+            "title": "{{service_name}} is {{alert_type}}!",
+            "description": "Carry on, looks like things are back! We were down for {{last_unhealthy_total_duration}} seconds.",
+            "color": 6480450,
+            "footer": {
+              "text": ""
+            },
+            "timestamp": "{{timestamp}}"
+          }
+        ],
+        "username": "Sky Puppy",
+        "avatar_url": "https://i.imgur.com/3rfFeOu.png"
+      }
+    }
+  },
+  "services": {
+    "your_service": {
+      "interval": 3,
+      "start_delay": 2,
+      "request": {
+        "uri": "http://127.0.0.1/a/cool/endpoint",
+        "timeout": 2,
+        "json": true,
+        "method": "PUT",
+        "body": {
+          "test": "sweet"
+        },
+      },
+      "alerts": [
+        {
+          "type": "down",
+          "alerter": "discord_down"
+        },
+        {
+          "type": "unhealthy",
+          "alerter": "discord_unhealthy"
+        },
+        {
+          "type": "healthy",
+          "alerter": "discord_healthy"
+        }
+      ]
+    }
+  },
+  "skypuppy": {
+    "version": "1.0.0"
+  }
+}
+
+```
+
+## Changelog
 
 {{doc1}}

changelog-template.hbs

@@ -1,5 +1,3 @@
-### Changelog
-
 All notable changes to this project will be documented in this file. Dates are displayed in UTC.
 
 {{#each releases}}

package.json

@@ -13,6 +13,9 @@
     "type": "git",
     "url": "git+https://github.com/Phara0h/sky-puppy.git"
   },
+  "bin": {
+    "sky-puppy": "./src/index.js"
+  },
   "keywords": [
     "prometheus",
     "health",
@@ -27,13 +30,20 @@
   },
   "homepage": "https://github.com/Phara0h/sky-puppy#readme",
   "dependencies": {
-    "auto-changelog": "^2.2.0",
-    "fasquest": "^2.4.0",
-    "fastify": "^2.15.3",
+    "fasquest": "^3.0.1",
+    "fastify": "^3.7.0",
+    "nbars": "^1.0.1",
+    "nstats": "^4.1.2"
+  },
+  "devDependencies": {
+    "eslint": "^7.8.1",
+    "eslint-config-prettier": "^6.11.0",
+    "eslint-plugin-prettier": "^3.1.4",
+    "prettier": "^2.0.5",
+    "prettier-eslint": "^11.0.0",
     "jsdoc-to-markdown": "^6.0.1",
+    "auto-changelog": "^2.2.0",
     "mdsquash": "^1.0.5",
-    "nbars": "^1.0.1",
-    "nstats": "^2.1.5",
-    "postgen": "^4.1.5"
+    "postgen": "^4.6.0"
   }
 }