Hoff 113- added Hof skeleton project

Dockerfile

@@ -0,0 +1,13 @@
+FROM quay.io/ukhomeofficedigital/nodejs-base:v6
+
+RUN mkdir /public
+
+COPY package.json /app/package.json
+RUN npm --loglevel warn install --production
+COPY . /app
+RUN npm --loglevel warn run postinstall --production
+RUN chown -R nodejs:nodejs /public
+
+USER nodejs
+
+CMD ["/app/run.sh"]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 UKHomeOffice
+
+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.

README.md

@@ -1 +1,47 @@
 # hof-skeleton
+This is to get you started with HOF. Use this to create a new project.
+
+## Install prerequisites
+
+Step 1 : Install Node Version Manager
+
+        curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
+        # or
+        wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
+        # or
+        brew install nvm
+
+        Any option you choose, please follow the next instruction on your terminal.
+
+    Check the version   nvm --version
+
+Step 2 : nvm install 18.19.0
+
+Step 3: nvm use 18.19.0
+
+Step 4: npm i -g yarn
+
+Step 5: yarn
+
+Step 6: yarn run start:dev
+
+- [Node.js](https://nodejs.org/en/) - Tested against LTS
+- NPM (installed with Node.js) - Works with versions 2 and 3
+- [Redis server](http://redis.io/download) running on the default port
+
+
+### Replacing existing project and settings with a prefered project name
+
+- In the apps folder rename the existing folder 'hof-project'.
+
+    > Example   apps/hof-project -->  apps/name-of-project .
+
+- navigate to the index.js file on line-4 replace 'hof-project'.
+
+    > Example  name: 'hof-project' -->   name: 'name-of-project'.
+
+- navigate to hof-settings.json on line-8 replace the app route.
+
+    > Example  "routes": [
+                    "./apps/hof-project"    -->  "./apps/name-of-project".
+                ],

apps/common/index.js

@@ -0,0 +1,11 @@
+'use strict';
+
+module.exports = {
+  name: 'common',
+  steps: {
+    '/start': {
+      template: 'start',
+      next: 'hof/welcome'
+    }
+  }
+};

apps/common/translations/en/default.json

@@ -0,0 +1,14 @@
+{
+  "buttons": {
+    "start-home": "Start Now"
+  },
+  "journey": {
+    "header": "HOF Service Form Template",
+    "phase": "beta"
+  },
+  "pages": {
+    "start": {
+      "header": "HOF Project Form Template"
+    }
+  }
+}

apps/common/translations/src/en/buttons.json

@@ -0,0 +1,3 @@
+{
+    "start-home": "Start Now"
+}

apps/common/translations/src/en/journey.json

@@ -0,0 +1,4 @@
+{
+    "header": "HOF Service Form Template",
+    "phase": "beta"
+  }

apps/common/translations/src/en/pages.json

@@ -0,0 +1,5 @@
+{
+    "start": {
+      "header": "HOF Project Form Template"
+    }
+}

apps/common/views/content/start.md

@@ -0,0 +1,7 @@
+
+
+## Our Project
+
+* Illegal Migration Act (IMA).
+* Electronic Travel Authorization (ETA).
+* Public Allegations Form (PAF).

apps/common/views/start.html

@@ -0,0 +1,6 @@
+{{<partials-page}}
+  {{$page-content}}
+    {{#markdown}}start{{/markdown}}
+    {{#input-submit}}start-home{{/input-submit}}
+  {{/page-content}}
+{{/partials-page}}

apps/hof-project/fields/index.js

@@ -0,0 +1,8 @@
+'use strict';
+
+module.exports = {
+    'welcome-textbox': {
+        mixin: 'input-text',
+        validate: ['notUrl', { type: 'maxlength', arguments: 50 }]
+      },
+};

apps/hof-project/index.js

@@ -0,0 +1,16 @@
+'use strict';
+
+module.exports = {
+  name: 'hof-project',
+  params: '/:action?/:id?/:edit?',
+  baseUrl: '/hof',
+  steps: {
+    '/welcome': {
+      fields: ['welcome-textbox'],
+      backLink: '/start',
+      next: '/confirm'
+    },
+    "/confirm": {}
+
+  }
+};

apps/hof-project/translations/en/default.json

@@ -0,0 +1,38 @@
+{
+  "buttons": {
+    "start-home": "Start Now"
+  },
+  "journey": {
+    "header": "New HOF Service Form",
+    "phase": "beta"
+  },
+  "pages": {
+    "start": {
+      "header": "HOF Project Form Template"
+    },
+    "welcome": {
+      "header": "Welcome to Hof Project",
+      "paragraph": "This completes your secure access to this service."
+    },
+    "confirm": {
+      "header": "Check your answers"
+    }
+  },
+  "button": {
+    "start-home": "Start Now",
+    "upload-file": "Upload",
+    "save-and-exit": "Save and exit",
+    "delete": "Delete",
+    "cancel": "Cancel",
+    "edit": "Change",
+    "continue-only": "Continue",
+    "save-and-continue": "Continue",
+    "confirm-submission": "Submit"
+  },
+  "fields": {
+    "welcome-textbox": {
+      "label": "Hof project number (if known)"
+    }
+  },
+  "validation": {}
+}

apps/hof-project/translations/src/en/button.json

@@ -0,0 +1,11 @@
+{
+    "start-home": "Start Now",
+    "upload-file": "Upload",
+    "save-and-exit": "Save and exit",
+    "delete": "Delete",
+    "cancel": "Cancel",
+    "edit": "Change",
+    "continue-only": "Continue",
+    "save-and-continue": "Continue",
+    "confirm-submission": "Submit"
+}

apps/hof-project/translations/src/en/fields.json

@@ -0,0 +1,5 @@
+{
+    "welcome-textbox": {
+        "label": "Hof project number (if known)"
+    }
+}

apps/hof-project/translations/src/en/journey.json

@@ -0,0 +1,4 @@
+{
+  "header": "New HOF Service Form",
+  "phase": "beta"
+}

apps/hof-project/translations/src/en/pages.json

@@ -0,0 +1,9 @@
+{
+  "welcome": {
+    "header": "Welcome to Hof Project",
+    "paragraph": "This completes your secure access to this service."
+  },
+  "confirm": {
+    "header": "Check your answers"
+  }
+}

apps/hof-project/translations/src/en/validation.json

@@ -0,0 +1 @@
+{}

apps/hof-project/views/welcome.html

@@ -0,0 +1,8 @@
+{{<partials-page}} 
+  {{$page-content}} 
+
+    {{#fields}}
+       {{#renderField}}{{/renderField}}
+    {{/fields}}
+  {{/page-content}}
+  {{/partials-page}}

assets/js/index.js

@@ -0,0 +1,16 @@
+'use strict';
+
+require('hof/frontend/themes/gov-uk/client-js');
+const govuk = require('govuk-frontend');
+const $ = require('jquery');
+const accessibleAutocomplete = require('accessible-autocomplete');
+
+
+$('.typeahead').each(function applyTypeahead() {
+    accessibleAutocomplete.enhanceSelectElement({
+        defaultValue: '',
+        selectElement: this
+    });
+});
+
+govuk.initAll();