NSJSA Automation Prototype

This is the source code for the NSJSA Automation prototype and its documentation site. It is built using the GOV.UK Prototype Kit and end extended with components frome the DWP Design System. This prototype is used to share ideas and to do user research.

Quickstart Guide

To run the site locally, clone the repo, install the npm dependencies and run the serve command. Once cloned, the repository should be self documenting – if not, contact a contributor for help.

Quickstart steps

1. Clone this repository

git clone https://github.com/tylensthilaire/nsjsa-automation-beta.git my-fork

2. Navigate to the directory

cd my-fork

3. Install dependencies

npm install

4. Run Locally

npx eleventy --serve

Conventions

Trunk based development separates the work in progress from work completed.

• main is the latest used to preview or QA work in progress.
• production a stable, live environment for researching with.

Date-based versioning allows us to look at the prototype as it was at a specific point in time.

• Add tags to commits used for research, show and tells, et al in the format YYMMDD-Event-Type.
• Create releases from these tags for archiving as needed.
• ‘Fix forward‘ to keep the commit history traceable

[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) keep the project history easy to understand.

• Each commit should add a whole feature or fix a whole bug.
• Commits should never 'break the build' so that we can test or share at any time.

Linting enforces code formatting and conventions consistent

• The GOV.UK Prototype Kit uses standardJS for javascript files.
• Other files use Prettier
• Recommended Visual Studio Code settings and extensions are included in the repository.

Continuous deployment processes automatically deploy the latest code pushed to Github for each branch with [Render](https://render.com/).

• When you add a branch (e.g. a release branch) you will need to configure a new app in Render
• main is deployed to nsjsa-automation-staging.onrender.com
• production is deployed to nsjsa-automation-cbkl.onrender.com

Self documenting code, in the form of comments, ensures the repo is easy for people to pick up and run with.

• Keep in mind that the GOV.UK Prototyping Kit is designed to require “minimal skills to get started”.
• Use extra README files per directory as required.

Project structure

.
├─ .vscode                            // Visual Studio Code workspace config files
│  ├─ extensions.json                 // Recommended extensions
│  └─ settings.json                   // Enforced settings
├─ app                                // Where your prototype lives
│  ├─ assets
│  │  ├─ images                       // Where images live
│  │  │  └< …
│  │  ├─ javascripts                  // Where js scripts live
│  │  │  └< …
│  │  └─ sass                         // Where Sass lives
│  │     └< …
│  ├─ data                            // Where data lives
│  │  └─ session-data-defaults.js     // Default data for applications in Service center UI
│  ├─ views                           // Your prototype screens
│  │  └< …
│  ├─ config.js                       // Prototype configuration
│  ├─ filters.js
│  └─ routes.js                       // Main routes file for branched journeys
├─ docs                               // Documentation
│  └< …
├─ lib                                // Makes everything work
│  └< …
├─ .gitignore                         // List of files not to version control
├─ .npmrc                             // NPM config
├─ .nvmrc                             // NVM config
├─ .prettierignore                    // List of ignored filetypes for Prettier
├─ LICENSE.txt
├─ listen-on-port.js
├─ package-lock.json                  // Manages dependencies strictly
├─ package.json                       // Manages dependencies
├─ Procfile                           // Sets Heroku startup commands
├─ README.md                        ☛ // YOU ARE HERE
├─ server.js
├─ start.js
└─ VERSION.txt                        // govuk-prototype-kit version

Support

For help with this prototype, contact a contributor or someone in the DWP Working Age Group.

The GOV.UK Prototype Kit is maintained by the Government Digital Service. For questions and support regarding the GOV.UK Prototyping Kit, look at the documentation in the govuk-prototype-kit repository for up to date contacts.

Technologies

This prototype is created using the following technologies:

• HTML / Nunjucks
• CSS / Sass
• Javascript
• JSON
• NodeJS

Contributing

This prototype is owned by the DWP Working Age team. Contact a contributor or a member of that team to discuss suggestions or contributions.

The govuk-prototype-kit repository is public and welcomes contributions from anyone.

Licence

This prototype inherits its licence (MIT) and copyright (Crown Copyright) from the GOV.UK Prototyping Kit. Read the licence.