Core delivery platform Node.js Frontend Template.

• Requirements
  • Node.js
• Local development
  • Setup
  • Development
  • Local JSON API
  • Production
  • Npm scripts
• Docker
  • Development Image
  • Production Image
• Licence
  • About the licence

Please install Node.js >= v18 and npm >= v9. You will find it easier to use the Node Version Manager nvm

To use the correct version of Node.js for this application, via nvm:

$ cd cdp-node-frontend-template
$ nvm use

Install application dependencies:

$ npm install

To run the application in development mode run:

$ npm run dev

Whilst the APIs are being developed this app uses a local JSON mock API. To start this locally run:

$ npm run mockApi

To mimic the application running in production mode locally run:

$ npm start

All available Npm scripts can be seen in package.json To view them in your command line run:

$ npm run

Build:

$ docker build --target development --no-cache --tag cdp-node-frontend-template:development .

Run:

$ docker run -p 3000:3000 cdp-node-frontend-template:development

Build:

docker build --no-cache --tag cdp-node-frontend-template .

Run:

$ docker run -p 3000:3000 cdp-node-frontend-template

THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:

http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3

The following attribution statement MUST be cited in your products and applications when using this information.

Contains public sector information licensed under the Open Government license v3

The Open Government Licence (OGL) was developed by the Controller of Her Majesty's Stationery Office (HMSO) to enable information providers in the public sector to license the use and re-use of their information under a common open licence.

It is designed to encourage use and re-use of information freely and flexibly, with only a few conditions.