cdp-example-node-frontend

Core delivery platform Node.js Frontend example.

Based on the CDP template https://github.com/DEFRA/cdp-node-frontend-template

---

• Requirements
  • Node.js
• Local development
  • Setup
  • Development
    • Updating dependencies
  • AWS CLI
    • AWS Local
      • AWS local alias
    • LocalStack
      • Docker
    • Localstack CLI
  • Local JSON API
  • Production
  • Npm scripts
• Docker
  • Development Image
  • Production Image
• Licence
  • About the licence

Requirements

Node.js

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-example-node-frontend
nvm use

Local development

Setup

Install application dependencies:

npm install

Development

To run the application in development mode run:

npm run dev

Updating dependencies

To update dependencies, globally install https://www.npmjs.com/package/npm-check-updates. Then run the below script, run tests, test the application and commit the altered package.json and package-lock.json files. For more options around updates check the package docs.

ncu -i

AWS CLI

• Install the AWS CLI https://aws.amazon.com/cli/

AWS Local

• awslocal is a wrapper around the AWS CLI that talks to your local localstack
• You can install a PIP https://github.com/localstack/awscli-local But note it only works with the older v1 of AWS CLI

AWS local alias

• Alternatively just alias it locally:

alias awslocal='aws --profile localstack $argv --endpoint-url http://localhost:4566'

• And add to your .aws/credentials

[localstack]
aws_access_key_id = test
aws_secret_access_key = test

LocalStack

Either run localstack directly via docker and AWS CLI, or via the localstack CLI.

Docker

• Run AWS LocalStack Docker container:

docker run --pull=always -d -p 4566:4566 -p 4510-4559:4510-4559 localstack/localstack:latest

Note the exposed endpoint is http://localhost:4566

Localstack CLI

• Install LocalStack CLI
• Run the CLI

localstack start

Note the exposed endpoint is https://localhost:4566

Local JSON API

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

npm run mockApi

Production

To mimic the application running in production mode locally run:

npm start

Npm scripts

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

npm run

Docker

Development image

Build:

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

Run:

docker run -p 3000:3000 cdp-example-node-frontend:development

Production image

Build:

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

Run:

docker run -p 3000:3000 cdp-example-node-frontend

Licence

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

About the licence

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.