Merge pull request #41 from ONS-Innovation/dashboard-refactor

KEH-1009 | Dashboard Refactor

Author: TotalDwarf03

CODEOWNERS .github/CODEOWNERSCODEOWNERS renamed to .github/CODEOWNERS

@@ -1,2 +1 @@
-@TotalDwarf03
 @ONS-Innovation/keh-dev

.github/workflows/md_lint.yml

@@ -0,0 +1,31 @@
+# A GitHub Action to run Markdown linting on pull requests and pushes using markdownlint.
+---
+name: Markdown Lint
+permissions:
+  contents: read
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+jobs:
+  markdown-lint:
+    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: '16'
+
+      - name: Install markdownlint
+        run: |
+          npm install -g markdownlint-cli
+
+      - name: Run markdownlint
+        run: |
+          markdownlint .

.markdownlint.json

@@ -0,0 +1,3 @@
+{
+    "MD013": false
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 ONS Innovation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -63,3 +63,13 @@ install-dev:  ## Install the dependencies including dev.
 .PHONY: run-local
 run-local:  ## Run locally.
 	streamlit run src/app.py
+
+.PHONY: md_lint
+md_lint: ## Lint Markdown files using Markdownlint.
+	sh shell_scripts/md_lint.sh
+	@echo "Markdownlint can fix some issues automatically. To fix them, run 'make md_fix'.";
+
+.PHONY: md_fix
+md_fix: ## Fix Markdown files using Markdownlint.
+	sh shell_scripts/md_fix.sh
+