Push Doctor Stylekit

The javascript and SCSS files used for Pushdoctor 2018

Getting started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

1. Install Node - https://nodejs.org/en/download
2. Install npm (node package manager) - https://www.npmjs.com/get-npm
3. Install gulp - in your command line

npm install --global gulp-cli

4. Clone Repo - in your command line, navigate to where you want the repo to live locally, enter the

https://pdrteam.visualstudio.com/DefaultCollection/Push%20Doctor%20Global/_git/nhsSite

Installing

Navigate into the cloned repo, then enter in your command line

npm install

Serving demo pages within the project

To build out the project, in your command line, enter

npm run start

The project will run, and will automatically open a browser window at localhost:3000/index.html. Files are served from dist. This will run a watch command so you can see any changes you make to the code (src/scss, src/templates, src/js) in that browser window.

Deployment

The environment file in the root of the project contains your settings that are subbed in as nunjucks template vars.

Deployment is done to an npm private repo under @pushdoctor. Contact Kevin, Rob or Matthew to be added as a developer, you will need this.

Enter your @pushdoctor npm details otherwise you will NOT be able to publish the repository.

npm login

To patch and deploy e.g. 0.0.1 to 0.0.2

 NODE_ENV<env> npm run release-patch

To minor version increment and deploy e.g. 0.0.1 to 0.1.1

 NODE_ENV<env> npm run release-minor

To major version increment and deploy e.g. 0.0.1 to 1.0.1

 NODE_ENV<env> npm run release-major

To prelease a beta version and deploy e.g. 0.0.1 to 0.0.2-1

 NODE_ENV<env> npm run release-beta

Build Styleguide

How to build the Styleguide

Open command line and enter the following

npm run styleguide

The styleguide will build out to styleguide/index.html

Deploy PushNHS to S3 Bucket

npm run deployaws

Thats it.. it deploys all the sites into one bucket. Home pages are :

• https://www.pushnhs.com/dev/index.html (dev)
• https://www.pushnhs.com/sit/index.html (sit)
• https://www.pushnhs.com/staging/index.html (staging)
• https://www.pushnhs.com/ (live)

Serving a local host build

npm run start

Then type in when asked which one you want to build locally and serve.

Locally you navigate relative to 'dist' folders contents.