Run the GOV.UK Prototype Kit locally

alphagov · Sep 5, 2023 · 788bdaf · 788bdaf
1 parent cabede6
commit 788bdaf
Show file tree

Hide file tree

Showing 4 changed files with 65 additions and 0 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -11,6 +11,7 @@
     ".github/workflows/scripts",
     "packages/govuk-frontend",
     "packages/govuk-frontend-review",
+    "packages/govuk-prototype-kit-review",
     "shared/*",
     "docs/examples/*"
   ],

diff --git a/packages/govuk-prototype-kit-review/README.md b/packages/govuk-prototype-kit-review/README.md
@@ -0,0 +1,8 @@
+# GOV.UK Prototype Kit review
+
+This package is used to review the GOV.UK Prototype Kit using a development version of GOV.UK Frontend.
+
+```shell
+npm run create --workspace govuk-protoype-kit-review
+npm run dev --workspace govuk-protoype-kit-review
+```
diff --git a/packages/govuk-prototype-kit-review/package.json b/packages/govuk-prototype-kit-review/package.json
@@ -0,0 +1,20 @@
+{
+  "private": true,
+  "name": "@govuk-frontend/govuk-prototype-kit-review",
+  "description": "GOV.UK Prototype Kit review",
+  "engines": {
+    "node": "^18.12.0",
+    "npm": "^8.1.0 || ^9.1.0"
+  },
+  "license": "MIT",
+  "scripts": {
+    "precreate": "del-cli dist",
+    "create": "govuk-prototype-kit create dist",
+    "postcreate": "cd dist && npm link ../../govuk-frontend",
+    "dev": "cd dist && govuk-prototype-kit dev"
+  },
+  "devDependencies": {
+    "del-cli": "^5.0.0",
+    "govuk-prototype-kit": "^13.13.1"
+  }
+}