CIP Night Apps Prototype

Site serving the CIP Night Applications Prototype.

Project Setup

Cloning the project

Clone the project using git:

git clone https://github.com/nhsbsa/cip-nightapps-prototype.git

git clone git@github.com:nhsbsa/cip-nightapps-prototype.git

NPM Setup

Once the project is cloned, run the following command to download and install node dependencies:

npm install
npm install gulp

If there are issues downloading dependencies, you may need to add the nhsbsa npm repository. To do this:

Create the file ~/.npmrc
Add the following configuration:

registry=https://dps-nexus.service.nhsbsa:8443/repository/npm
strict-ssl=false

Install the live reload plugin

Install the live reload plugin for your browser

Chrome

Running the Prototype locally

To run the prototype locally, use:

npm run watch

The prototype will then open a window in your browser on http://localhost:3000.

Browser sync settings can be accessed on http://localhost:3001.

Running Pa11y accessibility checks

install pa11y-ci using npm:

npm install -g pa11y-ci

then set up a json file with the name pa11y.json, with the below contents.

{
  "defaults": {
    "standard": "WCAG2AA",
    "timeout": 10000,
    "viewport": {
      "width": 1000,
      "height": 1000
    }
  },

  "urls": [
    "http://localhost:3000/"
  ]
}

These contents can be changed, such as the viewport width and height. You can also add all of your pages in the urls section. Then run the following command in your terminal to activate pa11y.

pa11y-ci -c pa11y.json

For more information please visit pa11y

Heroku

It is possible for this prototype to be viewed on Heroku. Please contact Matt Proctor-Leake with queries relating to this.

Procedure for merging branches

Pull in the latest version of main locally using

git pull origin main

Create a local branch using your initials followed by /. The describe the change, using the Jira ticket number if you have it.

For example, mpl/MM-700-discontinuation-journey

Make your changes locally and then push up to Github using your IDE commit tab, or using the following commands in your terminal:

git add .
git commit -m "change comments go here"
git push origin local-branch-name


Once pushed, there should be a highlight at the top of the repo asking to 'compare and pull request'. Select this button.


Then you need to add a reviewer and create the pull request


The reviewer will be notified and will review the changes before marking it as being able to be merged. Then it can be merged in to main from the pull request, and thus deployed to Heroku. If the reviewer is able to merge this on their side then they will notify the user who did the pull request that it has been completed.