CDP Node.js Backend Template

Core delivery platform Node.js Backend Template.

• Requirements
  • Node.js
• Local development
  • Setup
  • Development
  • Testing
  • Production
  • Npm scripts
  • Update dependencies
  • Formatting
    • Windows prettier issue
• API endpoints
• Calling API endpoints
  • Postman
• Development helpers
  • MongoDB Locks
• Docker
  • Development image
  • Production image
  • Docker Compose
  • Dependabot
  • SonarCloud
• 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-node-backend-template
nvm use

Local development

Setup

Install application dependencies:

npm install

Development

To run the application in development mode run:

npm run dev

Testing

To test the application run:

npm run test

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

Update dependencies

To update dependencies use npm-check-updates:

The following script is a good start. Check out all the options on the npm-check-updates

ncu --interactive --format group

Formatting

Windows prettier issue

If you are having issues with formatting of line breaks on Windows update your global git config by running:

git config --global core.autocrlf false

API endpoints

Endpoint	Description
GET: /health	Health
GET: /example	Example API (remove as needed)
GET: /example/<id>	Example API (remove as needed)

Calling API endpoints

Postman

A Postman collection and environment are available for making calls to the cdp-node-backend-template API. Simply import the collection and environment into Postman.

• CDP Node Backend Template Postman Collection
• CDP Node Backend Template Postman Environment

Development helpers

MongoDB Locks

If you require a write lock for Mongo you can acquire it via server.locker or request.locker:

async function doStuff(server) {
  const lock = await server.locker.lock('unique-resource-name')

  if (!lock) {
    // Lock unavailable
    return
  }

  try {
    // do stuff
  } finally {
    await lock.free()
  }
}

Keep it small and atomic.

You may use using for the lock resource management. Note test coverage reports do not like that syntax.

async function doStuff(server) {
  await using lock = await server.locker.lock('unique-resource-name')

  if (!lock) {
    // Lock unavailable
    return
  }

  // do stuff

  // lock automatically released
}

Helper methods are also available in /src/helpers/mongo-lock.js.

Docker

Development image

Build:

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

Run:

docker run -e PORT=3001 -p 3001:3001 cdp-node-backend-template:development

Production image

Build:

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

Run:

docker run -e PORT=3001 -p 3001:3001 cdp-node-backend-template

Docker Compose

A local environment with:

• Localstack for AWS services (S3, SQS)
• Redis
• MongoDB
• This service.
• A commented out frontend example.

docker compose up --build -d

Dependabot

We have added an example dependabot configuration file to the repository. You can enable it by renaming the .github/example.dependabot.yml to .github/dependabot.yml

SonarCloud

Instructions for setting up SonarCloud can be found in sonar-project.properties

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.