diff --git a/.github/workflows/lint_and_test_on_push.yml b/.github/workflows/lint_and_test_on_push.yml
index 09cbc9bb..d5ffba6f 100644
--- a/.github/workflows/lint_and_test_on_push.yml
+++ b/.github/workflows/lint_and_test_on_push.yml
@@ -15,4 +15,5 @@ jobs:
- uses: actions/checkout@v4
- run: |
npm ci
+ npx playwright install --with-deps
npm run test
\ No newline at end of file
diff --git a/.gitignore b/.gitignore
index 6a7d6d8e..6124179f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -127,4 +127,14 @@ dist
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
-.pnp.*
\ No newline at end of file
+.pnp.*
+
+# playwright
+/test-results/
+/playwright-report/*
+/playwright/.cache/
+
+public/*
+.vscode/launch.json
+
+uploads/*
diff --git a/.husky/pre-commit b/.husky/pre-commit
index 78e4bfb0..251a23e7 100755
--- a/.husky/pre-commit
+++ b/.husky/pre-commit
@@ -1,5 +1,4 @@
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"
-npm run test
npm run lint
\ No newline at end of file
diff --git a/config/default.yaml b/config/default.yaml
new file mode 100644
index 00000000..a96168be
--- /dev/null
+++ b/config/default.yaml
@@ -0,0 +1,8 @@
+port: 3000
+logs:
+ console: true
+ app: false
+ error: false
+api: {
+ url: http://localhost:3000/api
+}
diff --git a/config/index.js b/config/index.js
new file mode 100644
index 00000000..f94505dc
--- /dev/null
+++ b/config/index.js
@@ -0,0 +1,5 @@
+const HmpoConfig = require('hmpo-config')
+
+const config = new HmpoConfig()
+config.addFile('./config/default.yaml')
+module.exports = config.toJSON()
diff --git a/index.js b/index.js
index de00e3e1..71165038 100644
--- a/index.js
+++ b/index.js
@@ -1,19 +1,87 @@
+'use strict'
+
+const hmpoLogger = require('hmpo-logger')
const express = require('express')
+const cookieParser = require('cookie-parser')
+const session = require('express-session')
const nunjucks = require('nunjucks')
+const path = require('path')
+const bodyParser = require('body-parser')
+const config = require('./config')
+const { govukMarkdown } = require('@x-govuk/govuk-prototype-filters')
+
+const logger = hmpoLogger.config(config.logs).get()
+
const app = express()
-nunjucks.configure('src/views', {
- express: app
+// log access requests
+app.use(hmpoLogger.middleware())
+
+// add routing for static assets
+app.use('/public', express.static(path.resolve(__dirname, 'public')))
+
+// cookies and sessions (redis or elasticache should be used in a prod env)
+app.use(cookieParser())
+app.use(session({
+ secret: 'keyboard cat',
+ resave: false,
+ saveUninitialized: false,
+ cookie: { secure: false }
+}))
+
+// templating engine (turn on caching and turn off watching in prod env)
+app.set('view engine', 'html')
+const nunjucksEnv = nunjucks.configure([
+ 'src/views',
+ 'node_modules/govuk-frontend/',
+ 'node_modules/@x-govuk/govuk-prototype-components/'
+], {
+ express: app,
+ dev: true,
+ noCache: true,
+ watch: true
+})
+
+const globalValues = {
+ serviceName: 'Publish planning and housing data for England'
+}
+
+Object.keys(globalValues).forEach((key) => {
+ nunjucksEnv.addGlobal(key, globalValues[key])
})
+nunjucksEnv.addFilter('govukMarkdown', govukMarkdown)
-app.get('/', (req, res) => {
- const data = {
- title: 'Hello World',
- content: 'This is a sample content'
+// body parser
+app.use(bodyParser.urlencoded({ extended: true }))
+
+app.use('/', require('./src/routes/form-wizard'))
+
+// file not found handler
+app.use((req, res, next) => {
+ res.status(404).render('pages/file-not-found')
+})
+
+// error handler
+app.use((err, req, res, next) => {
+ logger.error('Request error', { req, err })
+
+ // handle session expired
+ if (err.code === 'SESSION_TIMEOUT') {
+ err.template = 'pages/session-expired'
+ }
+
+ // handle errors with automatic redirects
+ if (err.redirect) {
+ return res.redirect(err.redirect)
}
- res.render('helloWorld.html', data)
+
+ // show error page
+ err.status = err.status || 500
+ err.template = err.template || 'pages/error'
+ res.status(err.status).render(err.template, { err })
})
-app.listen(3000, () => {
- console.log('Server listening on port 3000')
+// listen for incomming requests
+app.listen(config.port, () => {
+ logger.info('App listening on http://localhost::port', { port: config.port })
})
diff --git a/package-lock.json b/package-lock.json
index 72490cab..f59b8fe4 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -75,246 +75,6 @@
"integrity": "sha512-0hYQ8SB4Db5zvZB4axdMHGwEaQjkZzFjQiN9LVYvIFB2nSUHW9tYpxWriPrWDASIxiaXax83REcLxuSdnGPZtw==",
"dev": true
},
- "node_modules/@esbuild/android-arm": {
- "version": "0.18.20",
- "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.18.20.tgz",
- "integrity": "sha512-fyi7TDI/ijKKNZTUJAQqiG5T7YjJXgnzkURqmGj13C6dCqckZBLdl4h7bkhHt/t0WP+zO9/zwroDvANaOqO5Sw==",
- "cpu": [
- "arm"
- ],
- "dev": true,
- "optional": true,
- "os": [
- "android"
- ],
- "engines": {
- "node": ">=12"
- }
- },
- "node_modules/@esbuild/android-arm64": {
- "version": "0.18.20",
- "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.18.20.tgz",
- "integrity": "sha512-Nz4rJcchGDtENV0eMKUNa6L12zz2zBDXuhj/Vjh18zGqB44Bi7MBMSXjgunJgjRhCmKOjnPuZp4Mb6OKqtMHLQ==",
- "cpu": [
- "arm64"
- ],
- "dev": true,
- "optional": true,
- "os": [
- "android"
- ],
- "engines": {
- "node": ">=12"
- }
- },
- "node_modules/@esbuild/android-x64": {
- "version": "0.18.20",
- "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.18.20.tgz",
- "integrity": "sha512-8GDdlePJA8D6zlZYJV/jnrRAi6rOiNaCC/JclcXpB+KIuvfBN4owLtgzY2bsxnx666XjJx2kDPUmnTtR8qKQUg==",
- "cpu": [
- "x64"
- ],
- "dev": true,
- "optional": true,
- "os": [
- "android"
- ],
- "engines": {
- "node": ">=12"
- }
- },
- "node_modules/@esbuild/darwin-arm64": {
- "version": "0.18.20",
- "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.18.20.tgz",
- "integrity": "sha512-bxRHW5kHU38zS2lPTPOyuyTm+S+eobPUnTNkdJEfAddYgEcll4xkT8DB9d2008DtTbl7uJag2HuE5NZAZgnNEA==",
- "cpu": [
- "arm64"
- ],
- "dev": true,
- "optional": true,
- "os": [
- "darwin"
- ],
- "engines": {
- "node": ">=12"
- }
- },
- "node_modules/@esbuild/darwin-x64": {
- "version": "0.18.20",
- "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.18.20.tgz",
- "integrity": "sha512-pc5gxlMDxzm513qPGbCbDukOdsGtKhfxD1zJKXjCCcU7ju50O7MeAZ8c4krSJcOIJGFR+qx21yMMVYwiQvyTyQ==",
- "cpu": [
- "x64"
- ],
- "dev": true,
- "optional": true,
- "os": [
- "darwin"
- ],
- "engines": {
- "node": ">=12"
- }
- },
- "node_modules/@esbuild/freebsd-arm64": {
- "version": "0.18.20",
- "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.18.20.tgz",
- "integrity": "sha512-yqDQHy4QHevpMAaxhhIwYPMv1NECwOvIpGCZkECn8w2WFHXjEwrBn3CeNIYsibZ/iZEUemj++M26W3cNR5h+Tw==",
- "cpu": [
- "arm64"
- ],
- "dev": true,
- "optional": true,
- "os": [
- "freebsd"
- ],
- "engines": {
- "node": ">=12"
- }
- },
- "node_modules/@esbuild/freebsd-x64": {
- "version": "0.18.20",
- "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.18.20.tgz",
- "integrity": "sha512-tgWRPPuQsd3RmBZwarGVHZQvtzfEBOreNuxEMKFcd5DaDn2PbBxfwLcj4+aenoh7ctXcbXmOQIn8HI6mCSw5MQ==",
- "cpu": [
- "x64"
- ],
- "dev": true,
- "optional": true,
- "os": [
- "freebsd"
- ],
- "engines": {
- "node": ">=12"
- }
- },
- "node_modules/@esbuild/linux-arm": {
- "version": "0.18.20",
- "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.18.20.tgz",
- "integrity": "sha512-/5bHkMWnq1EgKr1V+Ybz3s1hWXok7mDFUMQ4cG10AfW3wL02PSZi5kFpYKrptDsgb2WAJIvRcDm+qIvXf/apvg==",
- "cpu": [
- "arm"
- ],
- "dev": true,
- "optional": true,
- "os": [
- "linux"
- ],
- "engines": {
- "node": ">=12"
- }
- },
- "node_modules/@esbuild/linux-arm64": {
- "version": "0.18.20",
- "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.18.20.tgz",
- "integrity": "sha512-2YbscF+UL7SQAVIpnWvYwM+3LskyDmPhe31pE7/aoTMFKKzIc9lLbyGUpmmb8a8AixOL61sQ/mFh3jEjHYFvdA==",
- "cpu": [
- "arm64"
- ],
- "dev": true,
- "optional": true,
- "os": [
- "linux"
- ],
- "engines": {
- "node": ">=12"
- }
- },
- "node_modules/@esbuild/linux-ia32": {
- "version": "0.18.20",
- "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.18.20.tgz",
- "integrity": "sha512-P4etWwq6IsReT0E1KHU40bOnzMHoH73aXp96Fs8TIT6z9Hu8G6+0SHSw9i2isWrD2nbx2qo5yUqACgdfVGx7TA==",
- "cpu": [
- "ia32"
- ],
- "dev": true,
- "optional": true,
- "os": [
- "linux"
- ],
- "engines": {
- "node": ">=12"
- }
- },
- "node_modules/@esbuild/linux-loong64": {
- "version": "0.18.20",
- "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.18.20.tgz",
- "integrity": "sha512-nXW8nqBTrOpDLPgPY9uV+/1DjxoQ7DoB2N8eocyq8I9XuqJ7BiAMDMf9n1xZM9TgW0J8zrquIb/A7s3BJv7rjg==",
- "cpu": [
- "loong64"
- ],
- "dev": true,
- "optional": true,
- "os": [
- "linux"
- ],
- "engines": {
- "node": ">=12"
- }
- },
- "node_modules/@esbuild/linux-mips64el": {
- "version": "0.18.20",
- "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.18.20.tgz",
- "integrity": "sha512-d5NeaXZcHp8PzYy5VnXV3VSd2D328Zb+9dEq5HE6bw6+N86JVPExrA6O68OPwobntbNJ0pzCpUFZTo3w0GyetQ==",
- "cpu": [
- "mips64el"
- ],
- "dev": true,
- "optional": true,
- "os": [
- "linux"
- ],
- "engines": {
- "node": ">=12"
- }
- },
- "node_modules/@esbuild/linux-ppc64": {
- "version": "0.18.20",
- "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.18.20.tgz",
- "integrity": "sha512-WHPyeScRNcmANnLQkq6AfyXRFr5D6N2sKgkFo2FqguP44Nw2eyDlbTdZwd9GYk98DZG9QItIiTlFLHJHjxP3FA==",
- "cpu": [
- "ppc64"
- ],
- "dev": true,
- "optional": true,
- "os": [
- "linux"
- ],
- "engines": {
- "node": ">=12"
- }
- },
- "node_modules/@esbuild/linux-riscv64": {
- "version": "0.18.20",
- "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.18.20.tgz",
- "integrity": "sha512-WSxo6h5ecI5XH34KC7w5veNnKkju3zBRLEQNY7mv5mtBmrP/MjNBCAlsM2u5hDBlS3NGcTQpoBvRzqBcRtpq1A==",
- "cpu": [
- "riscv64"
- ],
- "dev": true,
- "optional": true,
- "os": [
- "linux"
- ],
- "engines": {
- "node": ">=12"
- }
- },
- "node_modules/@esbuild/linux-s390x": {
- "version": "0.18.20",
- "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.18.20.tgz",
- "integrity": "sha512-+8231GMs3mAEth6Ja1iK0a1sQ3ohfcpzpRLH8uuc5/KVDFneH6jtAJLFGafpzpMRO6DzJ6AvXKze9LfFMrIHVQ==",
- "cpu": [
- "s390x"
- ],
- "dev": true,
- "optional": true,
- "os": [
- "linux"
- ],
- "engines": {
- "node": ">=12"
- }
- },
"node_modules/@esbuild/linux-x64": {
"version": "0.18.20",
"resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.18.20.tgz",
@@ -331,102 +91,6 @@
"node": ">=12"
}
},
- "node_modules/@esbuild/netbsd-x64": {
- "version": "0.18.20",
- "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.18.20.tgz",
- "integrity": "sha512-iO1c++VP6xUBUmltHZoMtCUdPlnPGdBom6IrO4gyKPFFVBKioIImVooR5I83nTew5UOYrk3gIJhbZh8X44y06A==",
- "cpu": [
- "x64"
- ],
- "dev": true,
- "optional": true,
- "os": [
- "netbsd"
- ],
- "engines": {
- "node": ">=12"
- }
- },
- "node_modules/@esbuild/openbsd-x64": {
- "version": "0.18.20",
- "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.18.20.tgz",
- "integrity": "sha512-e5e4YSsuQfX4cxcygw/UCPIEP6wbIL+se3sxPdCiMbFLBWu0eiZOJ7WoD+ptCLrmjZBK1Wk7I6D/I3NglUGOxg==",
- "cpu": [
- "x64"
- ],
- "dev": true,
- "optional": true,
- "os": [
- "openbsd"
- ],
- "engines": {
- "node": ">=12"
- }
- },
- "node_modules/@esbuild/sunos-x64": {
- "version": "0.18.20",
- "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.18.20.tgz",
- "integrity": "sha512-kDbFRFp0YpTQVVrqUd5FTYmWo45zGaXe0X8E1G/LKFC0v8x0vWrhOWSLITcCn63lmZIxfOMXtCfti/RxN/0wnQ==",
- "cpu": [
- "x64"
- ],
- "dev": true,
- "optional": true,
- "os": [
- "sunos"
- ],
- "engines": {
- "node": ">=12"
- }
- },
- "node_modules/@esbuild/win32-arm64": {
- "version": "0.18.20",
- "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.18.20.tgz",
- "integrity": "sha512-ddYFR6ItYgoaq4v4JmQQaAI5s7npztfV4Ag6NrhiaW0RrnOXqBkgwZLofVTlq1daVTQNhtI5oieTvkRPfZrePg==",
- "cpu": [
- "arm64"
- ],
- "dev": true,
- "optional": true,
- "os": [
- "win32"
- ],
- "engines": {
- "node": ">=12"
- }
- },
- "node_modules/@esbuild/win32-ia32": {
- "version": "0.18.20",
- "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.18.20.tgz",
- "integrity": "sha512-Wv7QBi3ID/rROT08SABTS7eV4hX26sVduqDOTe1MvGMjNd3EjOz4b7zeexIR62GTIEKrfJXKL9LFxTYgkyeu7g==",
- "cpu": [
- "ia32"
- ],
- "dev": true,
- "optional": true,
- "os": [
- "win32"
- ],
- "engines": {
- "node": ">=12"
- }
- },
- "node_modules/@esbuild/win32-x64": {
- "version": "0.18.20",
- "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.18.20.tgz",
- "integrity": "sha512-kTdfRcSiDfQca/y9QIkng02avJ+NCaQvrMejlsB3RRv5sE9rRoeBPISaZpKxHELzRxZyLvNts1P27W3wV+8geQ==",
- "cpu": [
- "x64"
- ],
- "dev": true,
- "optional": true,
- "os": [
- "win32"
- ],
- "engines": {
- "node": ">=12"
- }
- },
"node_modules/@eslint-community/eslint-utils": {
"version": "4.4.0",
"resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.4.0.tgz",
@@ -3751,19 +3415,6 @@
"resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz",
"integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw=="
},
- "node_modules/fsevents": {
- "version": "2.3.3",
- "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz",
- "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==",
- "hasInstallScript": true,
- "optional": true,
- "os": [
- "darwin"
- ],
- "engines": {
- "node": "^8.16.0 || ^10.6.0 || >=11.0.0"
- }
- },
"node_modules/function-bind": {
"version": "1.1.2",
"resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz",
@@ -6444,20 +6095,6 @@
"node": ">=16"
}
},
- "node_modules/playwright/node_modules/fsevents": {
- "version": "2.3.2",
- "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.2.tgz",
- "integrity": "sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==",
- "dev": true,
- "hasInstallScript": true,
- "optional": true,
- "os": [
- "darwin"
- ],
- "engines": {
- "node": "^8.16.0 || ^10.6.0 || >=11.0.0"
- }
- },
"node_modules/pluralize": {
"version": "8.0.0",
"resolved": "https://registry.npmjs.org/pluralize/-/pluralize-8.0.0.tgz",
diff --git a/package.json b/package.json
index 20218f93..0280a819 100644
--- a/package.json
+++ b/package.json
@@ -4,14 +4,22 @@
"description": "",
"main": "index.js",
"scripts": {
- "test": "vitest run",
- "test:watch": "vitest",
- "test:coverage": "vitest --coverage",
- "lint": "standard",
- "lint:fix": "standard --fix",
+ "prepare": "husky install",
"start": "node index.js",
- "nodemon": "nodemon index.js",
- "prepare": "husky install"
+ "start:watch": "concurrently \"nodemon .index.js\" \"npm run scss:watch\"",
+ "scss": "sass --quiet-deps --load-path=./ src/assets/scss:public/stylesheets",
+ "scss:watch": "sass --quiet-deps --load-path=./ --watch src/assets/scss:public/stylesheets",
+ "test": "npm run test:unit && npm run test:integration && npm run test:contract && npm run test:acceptance",
+ "test:unit": "vitest run test/unit",
+ "test:integration": "vitest run test/integration",
+ "test:contract": "vitest run test/contract",
+ "test:watch": "vitest test/unit test/integration test/contract",
+ "test:coverage": "vitest test/unit test/integration test/contract --coverage",
+ "test:acceptance": "playwright test",
+ "test:acceptance:ui": "playwright test --ui",
+ "test:acceptance:codegen": "playwright codegen http://localhost:3000",
+ "lint": "standard",
+ "lint:fix": "standard --fix"
},
"engines": {
"node": ">=18.0.0 <20.0.0"
diff --git a/playwright.config.js b/playwright.config.js
new file mode 100644
index 00000000..cc8903d7
--- /dev/null
+++ b/playwright.config.js
@@ -0,0 +1,78 @@
+// @ts-check
+const { defineConfig, devices } = require('@playwright/test')
+
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
+// require('dotenv').config();
+
+/**
+ * @see https://playwright.dev/docs/test-configuration
+ */
+module.exports = defineConfig({
+ testDir: './test/acceptance',
+ /* Run tests in files in parallel */
+ fullyParallel: true,
+ /* Fail the build on CI if you accidentally left test.only in the source code. */
+ forbidOnly: !!process.env.CI,
+ /* Retry on CI only */
+ retries: process.env.CI ? 2 : 0,
+ /* Opt out of parallel tests on CI. */
+ workers: process.env.CI ? 1 : undefined,
+ /* Reporter to use. See https://playwright.dev/docs/test-reporters */
+ reporter: 'html',
+ /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
+ use: {
+ /* Base URL to use in actions like `await page.goto('/')`. */
+ baseURL: 'http://127.0.0.1:3000',
+
+ /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+ trace: 'on-first-retry'
+ },
+
+ /* Configure projects for major browsers */
+ projects: [
+ {
+ name: 'chromium',
+ use: { ...devices['Desktop Chrome'] }
+ },
+
+ {
+ name: 'firefox',
+ use: { ...devices['Desktop Firefox'] }
+ },
+
+ {
+ name: 'webkit',
+ use: { ...devices['Desktop Safari'] }
+ }
+
+ /* Test against mobile viewports. */
+ // {
+ // name: 'Mobile Chrome',
+ // use: { ...devices['Pixel 5'] },
+ // },
+ // {
+ // name: 'Mobile Safari',
+ // use: { ...devices['iPhone 12'] },
+ // },
+
+ /* Test against branded browsers. */
+ // {
+ // name: 'Microsoft Edge',
+ // use: { ...devices['Desktop Edge'], channel: 'msedge' },
+ // },
+ // {
+ // name: 'Google Chrome',
+ // use: { ...devices['Desktop Chrome'], channel: 'chrome' },
+ // },
+ ],
+
+ /* Run your local dev server before starting the tests */
+ webServer: {
+ command: 'npm run start',
+ url: 'http://127.0.0.1:3000',
+ reuseExistingServer: !process.env.CI
+ }
+})
diff --git a/readme.md b/readme.md
index 26d56d24..2b7598f8 100644
--- a/readme.md
+++ b/readme.md
@@ -13,9 +13,17 @@ This is the frontend for the LPA Data Validator application. It is a nodeJS expr
```
npm run prepare
```
+- compile scss file
+ ```
+ npm run scss
+ ```
## Running the application
- Run the application
+ ```
+ npm run start
+ ```
+- Run the application in watch mode
```
npm run start
```
\ No newline at end of file
diff --git a/src/assets/scss/index.scss b/src/assets/scss/index.scss
new file mode 100644
index 00000000..a6ceec3f
--- /dev/null
+++ b/src/assets/scss/index.scss
@@ -0,0 +1,2 @@
+@import "node_modules/govuk-frontend/govuk/all";
+@import "node_modules/@x-govuk/govuk-prototype-components/x-govuk/all";
\ No newline at end of file
diff --git a/src/controllers/datasetController.js b/src/controllers/datasetController.js
new file mode 100644
index 00000000..7cf971cf
--- /dev/null
+++ b/src/controllers/datasetController.js
@@ -0,0 +1,59 @@
+'use strict'
+
+const { Controller } = require('hmpo-form-wizard')
+
+const datasetOptions = {
+ 'Article 4': [
+ {
+ value: 'Article 4 direction dataset',
+ text: 'Article 4 direction dataset'
+ },
+ {
+ value: 'Article 4 direction area dataset',
+ text: 'Article 4 direction area dataset'
+ }
+ ],
+ 'Conservation area': [
+ {
+ value: 'Conservation area dataset',
+ text: 'Conservation area dataset'
+ },
+ {
+ value: 'Conservation area document dataset',
+ text: 'Conservation area document dataset'
+ }
+ ],
+ 'Tree preservation order': [
+ {
+ value: 'Tree preservation order dataset',
+ text: 'Tree preservation order dataset'
+ },
+ {
+ value: 'Tree preservation zone dataset',
+ text: 'Tree preservation zone dataset'
+ },
+ {
+ value: 'Tree dataset',
+ text: 'Tree dataset'
+ }
+ ],
+ 'Listed building': false
+}
+
+class DatasetController extends Controller {
+ get (req, res, next) {
+ const dataset = req.sessionModel.get('data-subject')
+ const options = datasetOptions[dataset]
+
+ if (options) {
+ this.availableDatasets = options
+ req.form.options.datasetItems = options
+ super.get(req, res, next)
+ } else {
+ // skip to next step of form wizard
+ this.successHandler(req, res, next)
+ }
+ }
+}
+
+module.exports = DatasetController
diff --git a/src/controllers/submitForm.js b/src/controllers/submitForm.js
new file mode 100644
index 00000000..49ca60e5
--- /dev/null
+++ b/src/controllers/submitForm.js
@@ -0,0 +1,41 @@
+'use strict'
+
+const { Controller } = require('hmpo-form-wizard')
+
+const { readFile } = require('node:fs/promises')
+const { lookup } = require('mime-types')
+
+const apiRoute = 'http://127.0.0.1:8082/api/dataset/validate/file/request/'
+
+class SubmitForm extends Controller {
+ async post (req, res, next) {
+ const formData = new FormData()
+ formData.append('dataset', req.sessionModel.get('dataset'))
+ formData.append('collection', req.sessionModel.get('data-subject'))
+ formData.append('organization', 'mockOrg')
+
+ const filePath = req.sessionModel.get('datafile').path
+ const file = new Blob([await readFile(filePath)], { type: lookup(filePath) })
+
+ formData.append('upload_file', file, req.sessionModel.get('datafile').originalname)
+
+ try {
+ // post the data to the api
+ const result = await fetch(apiRoute, {
+ method: 'POST',
+ body: formData
+ })
+
+ const json = await result.json()
+
+ console.log(json)
+
+ // send the response back to the user
+ res.send(json)
+ } catch (e) {
+ res.send(e)
+ }
+ }
+}
+
+module.exports = SubmitForm
diff --git a/src/controllers/uploadController.js b/src/controllers/uploadController.js
new file mode 100644
index 00000000..71d69b33
--- /dev/null
+++ b/src/controllers/uploadController.js
@@ -0,0 +1,19 @@
+'use strict'
+const multer = require('multer')
+const upload = multer({ dest: 'uploads/' })
+
+const { Controller } = require('hmpo-form-wizard')
+
+class UploadController extends Controller {
+ middlewareSetup () {
+ super.middlewareSetup()
+ this.use('/upload', upload.single('datafile'))
+ }
+
+ post (req, res, next) {
+ req.body.datafile = req.file
+ super.post(req, res, next)
+ }
+}
+
+module.exports = UploadController
diff --git a/src/routes/form-wizard/fields.js b/src/routes/form-wizard/fields.js
new file mode 100644
index 00000000..1a97b402
--- /dev/null
+++ b/src/routes/form-wizard/fields.js
@@ -0,0 +1,11 @@
+module.exports = {
+ 'data-subject': {
+ validate: 'required'
+ },
+ dataset: {
+ validate: 'required'
+ },
+ datafile: {
+ validate: 'required'
+ }
+}
diff --git a/src/routes/form-wizard/index.js b/src/routes/form-wizard/index.js
new file mode 100644
index 00000000..39d7af0b
--- /dev/null
+++ b/src/routes/form-wizard/index.js
@@ -0,0 +1,10 @@
+const { Router } = require('express')
+const wizard = require('hmpo-form-wizard')
+const steps = require('./steps')
+const fields = require('./fields')
+
+const app = Router()
+
+app.use(wizard(steps, fields, { name: 'my-wizard', csrf: false }))
+
+module.exports = app
diff --git a/src/routes/form-wizard/steps.js b/src/routes/form-wizard/steps.js
new file mode 100644
index 00000000..0c867e2e
--- /dev/null
+++ b/src/routes/form-wizard/steps.js
@@ -0,0 +1,26 @@
+module.exports = {
+ '/': {
+ entryPoint: true,
+ resetJourney: true,
+ next: 'data-subject',
+ template: '../views/start.html'
+ },
+ '/data-subject': {
+ fields: ['data-subject'],
+ next: 'dataset'
+ },
+ '/dataset': {
+ controller: require('../../controllers/datasetController'),
+ fields: ['dataset'],
+ next: 'upload'
+ },
+ '/upload': {
+ controller: require('../../controllers/uploadController'),
+ fields: ['datafile', 'path'],
+ next: 'submit'
+ },
+ '/submit': {
+ controller: require('../../controllers/submitForm'),
+ next: 'done'
+ }
+}
diff --git a/src/views/data-subject.html b/src/views/data-subject.html
new file mode 100644
index 00000000..e762c8b8
--- /dev/null
+++ b/src/views/data-subject.html
@@ -0,0 +1,58 @@
+{% extends "layouts/main.html" %}
+
+{% from 'govuk/components/back-link/macro.njk' import govukBackLink %}
+{% from 'govuk/components/button/macro.njk' import govukButton %}
+{% from 'govuk/components/radios/macro.njk' import govukRadios %}
+
+{% set pageName = 'Data subject' %}
+
+{% block beforeContent %}
+ {{ govukBackLink({
+ text: "Back",
+ href: "javascript:window.history.back()"
+ }) }}
+{% endblock %}
+
+{% block content %}
+
+{% endblock %}
diff --git a/src/views/dataset.html b/src/views/dataset.html
new file mode 100644
index 00000000..f4559f87
--- /dev/null
+++ b/src/views/dataset.html
@@ -0,0 +1,40 @@
+{% extends "layouts/main.html" %}
+{% from 'govuk/components/back-link/macro.njk' import govukBackLink %}
+{% from 'govuk/components/button/macro.njk' import govukButton %}
+{% from 'govuk/components/radios/macro.njk' import govukRadios %}
+
+{% set pageName = 'Dataset' %}
+
+{% block beforeContent %}
+ {{ govukBackLink({
+ text: "Back",
+ href: "javascript:window.history.back()"
+ }) }}
+{% endblock %}
+
+{% block content %}
+
+{% endblock %}
diff --git a/src/views/helloWorld.html b/src/views/helloWorld.html
deleted file mode 100644
index 74ee5177..00000000
--- a/src/views/helloWorld.html
+++ /dev/null
@@ -1,8 +0,0 @@
-
-
-
- {{title}}
-
- {{title}}
- {{content}}
-
diff --git a/src/views/layouts/main.html b/src/views/layouts/main.html
new file mode 100644
index 00000000..9e3c8352
--- /dev/null
+++ b/src/views/layouts/main.html
@@ -0,0 +1,68 @@
+{#
+For guidance on how to use layouts see:
+https://prototype-kit.service.gov.uk/docs/how-to-use-layouts
+#}
+
+{% extends "govuk/template.njk" %}
+{% from 'govuk/components/header/macro.njk' import govukHeader%}
+{% from 'govuk/components/footer/macro.njk' import govukFooter%}
+{% from 'govuk/components/phase-banner/macro.njk' import govukPhaseBanner%}
+
+{% block head %}
+ feedback will help us to improve it.',
+ classes: 'govuk-width-container'
+ }) }}
+ Get help
+
+ Email: digitalland@levellingup.gov.uk
+ You’ll get a response within 5 working days.
+
+ {{err.code + " - " if err.code}}{{err.message}}
+ {%if err.stack %}
+ {{err.stack | safe}}
+ {% endif %}
+{% endblock %}
diff --git a/src/views/start.html b/src/views/start.html
new file mode 100644
index 00000000..b058cb88
--- /dev/null
+++ b/src/views/start.html
@@ -0,0 +1,116 @@
+{% extends "layouts/main.html" %}
+{% from "govuk/components/button/macro.njk" import govukButton %}
+{% from "govuk/components/details/macro.njk" import govukDetails %}
+{% from "x-govuk/components/related-navigation/macro.njk" import xGovukRelatedNavigation %}
+
+
+{% set pageName = serviceName %}
+
+{% block content %}
+
+{% set example %}
+
+ ## About the data
+
+ This dataset shows the locations of conservation areas. Conservation areas are designated to safeguard areas of special architectural and historic interest, the character and appearance of which it is desirable to preserve or enhance. Within these areas special planning controls operate which need to be considered when undertaking development.
+
+ ## Data
+
+ [Southwark conservations areas (CSV, 188KB)](#)
+
+ ## Licensing
+
+ The data is provided under the [Open Government Licence](#).
+
+ ## Last updated
+
+ The data was last updated on 14 July 2023 at 9am.
+
+{% endset %}
+
+{% set content %}
+
+ Use this service to:
+
+ - check your data follows the standard
+ - get your data published
+
+
+
+ ## Before you check your data
+
+ You need to prepare your:
+
+ - conservation area data
+ - listed building data
+ - article 4 direction data
+ - tree preservation order data
+
+ You may need to create more than one set of data for each subject. You'll find what to include in the [data specifications](https://www.planning.data.gov.uk/guidance/specifications/).
+
+ We will accept data supplied as either:
+
+ - CSV
+ - GeoJSON
+ - GML
+ - GeoPackage
+
+ {# These may be uploaded to a single URL, or served via an OGC WFS or ArcGIS API. #}
+
+ ## Before you can publish your data
+
+ You must be able to create or edit a webpage on your local planning authority’s (LPA) website. This will probably have a URL ending in .gov.uk or .org.
+
+ If you’re not able to do this, you’ll need to ask the person who updates your website.
+
+ The webpage needs to include:
+
+ - a summary of what the data is about
+ - a confirmation that the data is provided under the Open Government License
+ - the date you created or updated the webpage
+ - links to your data on this page, for example a CSV
+
+ {{ govukDetails({
+ summaryText: "Example webpage",
+ text: example | govukMarkdown(headingsStartWith="m")
+ }) }}
+
+ This webpage URL must not change, so we can keep collecting the data. If the URL does change, send an email to [digitalland@levellingup.gov.uk](mailto:digitalland@levellingup.gov.uk).
+
+{% endset %}
+
+
+
+
+ {{serviceName}}
+
+
+
+
+ {{content | govukMarkdown |safe}}
+
+
+ {{ xGovukRelatedNavigation({
+ sections: [{
+ items: [{
+ text: "Data specifications",
+ href: "/"
+ }],
+ subsections: [{
+ title: "Explore the topic",
+ items: [{
+ text: "Housing and planning",
+ href: "/browse/performing-arts"
+ }]
+ }]
+ }]
+ }) }}
+
+
+
+
Submit your completed form
+ {% for key, value in options['allFields'] %}
+
{{key}}: {{values[key]}}
+ {% endfor %}
+
+
+