Merge pull request #1 from iFixit/port-lighthouse-docker

Author: ardelato

.env.template

@@ -0,0 +1,2 @@
+DD_API_KEY=
+DD_APP_KEY=

.gitignore

@@ -29,3 +29,10 @@ node_modules/
 
 # VSCode Misc.
 .vscode
+
+# Config Files
+urls.json
+metrics-config.json
+
+# TSC Output
+dist

README.md

@@ -1,2 +1,33 @@
-# vigilo
+# Vigilo
+🚧 Still in development 🚧
+
 Vigilo is a monitoring tool that automates Lighthouse audits and sends key metrics to Datadog. Designed to keep a vigilant eye on your web application's performance and accessibility.
+
+### Setup
+1. Clone the repo
+2. Run `pnpm install`
+3. Run `pnpm run build`
+4. Run `cp .env.template .env`
+5. Add your Datadog API key and Datadog Application key to the `.env` file
+6. Run `cp urls.example.json urls.json`
+7. Add your URLs to the `urls.json` file
+8. Run `cp metrics.example.json metrics.json`
+9. Add the metrics you want to send to Datadog to the `metrics.json` file
+
+⚠️ If you are setting this up on a Windows machine via WSL, then you will need to run the following commands to ensure the correct linux dependencies are installed:
+**Make sure dependencies are up to date**
+```
+sudo apt update && sudo apt -y upgrade && sudo apt -y autoremove
+```
+**Download and Install Chrome**
+```
+wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
+sudo apt -y install ./google-chrome-stable_current_amd64.deb
+```
+**Check Chrome was Successfully Installed**
+```
+google-chrome --version
+```
+
+### Usage
+1. After setup, run `pnpm start` to run vigilo and send metrics to Datadog

metrics-config.example.json

@@ -0,0 +1,13 @@
+{
+    "audits": [
+        "largest-contentful-paint",
+        "first-contentful-paint",
+        "cumulative-layout-shift",
+        "total-blocking-time",
+        "speed-index",
+        "total-byte-weight",
+        "server-response-time",
+        "is-crawlable",
+        "screenshot-thumbnails"
+    ]
+}

package.json

@@ -7,7 +7,8 @@
   "type": "module",
   "scripts": {
     "start": "node dist/index.js",
-    "build": "tsc",
+    "clean": "rm -rf dist",
+    "build": "pnpm clean && tsc",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "keywords": [],
@@ -17,5 +18,11 @@
     "@tsconfig/node18": "^18.2.1",
     "@types/node": "^20.5.9",
     "typescript": "^5.2.2"
+  },
+  "dependencies": {
+    "@datadog/datadog-api-client": "^1.16.0",
+    "dotenv": "^16.3.1",
+    "lighthouse": "^11.1.0",
+    "puppeteer": "^21.2.1"
   }
 }