README.md

CDP User Service Backend

Core delivery platform User Service Backend.

• Requirements
  • Node.js
• Local development
  • Setup
  • Development
    • Updating dependencies
  • Production
  • Npm scripts
• API endpoints
• Calling API endpoints
  • Postman
• Versioning
  • Auto minor versioning
  • Major or Patch versioning
• 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-user-service-backend
$ 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

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

API endpoints

Endpoint	Description
GET: /health	Health
GET: /v1/entities	Entities
GET: /v1/entities/<entityId>	Entity by ID

Calling API endpoints

Postman

A Postman collection and environment are available for making calls to the Teams and Repositories API. Simply import the collection and environment into Postman.

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

Versioning

Auto minor versioning

The Publish GitHub Actions workflow auto versions a Pull Requests code with a minor version once it has been merged into the main branch. All you have to do is commit your code and raise a Pull Request and the pipeline will auto version your code for you.

Major or Patch versioning

If you wish to patch or major version your codebase use:

$ npm version <patch|major>

Then:

• Push this code with the auto generated commit to your GitHub Repository
• Raise a Pull Request
• Merge your code into the main branch
• The Publish GitHub Actions workflow will tag and push your major or patch version tags to your GitHub Repository
• The Publish GitHub Actions workflow will release your major or patch versioned code

Docker

Development image

Build:

$ docker build --target development --no-cache --tag cdp-user-service-backend:development .

Run:

$ docker run -e GITHUB_API_TOKEN -p 3008:3008 cdp-user-service-backend:development

Production image

Build:

docker build --no-cache --tag cdp-user-service-backend .

Run:

$ docker run -e GITHUB_API_TOKEN -p 3001:3001 cdp-user-service-backend

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.