Merge pull request #80 from teomrd/lighthouse-badges

feat(lighthouse): include performance badges on ReadMe

.github/workflows/on-main.yml

@@ -0,0 +1,28 @@
+name: Generate Lighthouse Badges
+on:
+  push:
+    branches:
+      - main
+jobs:
+    generate-lighthouse-badges:
+      runs-on: ubuntu-latest
+      steps:
+        - name: Checkout code
+          uses: actions/checkout@v4
+        - name: Set up Node.js
+          uses: actions/setup-node@v4
+          with:
+            node-version: '20'
+        - name: Run Lighthouse and generate badges
+          run: |
+            make lighthouse-badges
+
+        - name: Push badges to repo
+          run: |
+            git config --global user.name "GitHub Action"
+            git config --global user.email "action@github.com"
+            git add ./docs/lighthouse
+            git commit -m "Update Lighthouse badges"
+            git push
+          env:
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.lighthouserc.json

@@ -23,7 +23,7 @@
         "categories.best-practices" : [
           "error",
           {
-            "minScore": 0.95
+            "minScore": 0.96
           }
         ],
         "categories.seo" : [

Makefile

@@ -28,6 +28,9 @@ checks: install compile build verify-formatting lint
 lighthouse-audit: install build
 	lhci autorun
 
+lighthouse-badges:
+	npx lighthouse-badges -o docs/lighthouse/badges -u https://teomrd.github.io/miropad/
+
 clean:
 	deno clean
 	rm -rf ./node_modules

README.md

@@ -2,6 +2,13 @@
 
 > Temporary note keeping app for the browser
 
+## Lighthouse Audit scores
+
+[![Lighthouse Performance Badge](./docs/lighthouse/badges/lighthouse_performance.svg)](https://github.com/teomrd/miropad)
+[![Lighthouse Accessibility Badge](./docs/lighthouse/badges/lighthouse_accessibility.svg)](https://github.com/teomrd/miropad)
+[![Lighthouse Best Practices Badge](./docs/lighthouse/badges/lighthouse_best-practices.svg)](https://github.com/teomrd/miropad)
+[![Lighthouse SEO Badge](./docs/lighthouse/badges/lighthouse_seo.svg)](https://github.com/teomrd/miropad)
+
 ## Usage
 
 ```commands
@@ -31,6 +38,4 @@ following the pattern.
 
 `git config commit.template ./.gitmessage`
 
-## Lighthouse Audit results
 
-![Lighthouse Audit results](docs/lighthouse-results.gif)