https://github.com/defra/cdp-example-node-backend
Git repository for service cdp-example-node-backend
https://github.com/defra/cdp-example-node-backend
backend cdp node service
Last synced: 2 months ago
JSON representation
Git repository for service cdp-example-node-backend
- Host: GitHub
- URL: https://github.com/defra/cdp-example-node-backend
- Owner: DEFRA
- License: other
- Created: 2024-02-09T12:58:46.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2026-04-13T12:59:21.000Z (3 months ago)
- Last Synced: 2026-04-13T14:28:40.332Z (3 months ago)
- Topics: backend, cdp, node, service
- Language: JavaScript
- Size: 563 KB
- Stars: 0
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# cdp-example-node-backend
Core delivery platform Node.js Backend example.
Based on the CDP template https://github.com/DEFRA/cdp-node-backend-template.
[](https://sonarcloud.io/summary/new_code?id=DEFRA_cdp-example-node-backend)
---
- [Requirements](#requirements)
- [Node.js](#nodejs)
- [Local development](#local-development)
- [Setup](#setup)
- [Development](#development)
- [Updating dependencies](#updating-dependencies)
- [Production](#production)
- [Npm scripts](#npm-scripts)
- [API endpoints](#api-endpoints)
- [Calling API endpoints](#calling-api-endpoints)
- [Postman](#postman)
- [Docker](#docker)
- [Development Image](#development-image)
- [Production Image](#production-image)
- [Licence](#licence)
- [About the licence](#about-the-licence)
## Requirements
### Node.js
Please install [Node.js](http://nodejs.org/) `>= v18` and [npm](https://nodejs.org/) `>= v9`. You will find it
easier to use the Node Version Manager [nvm](https://github.com/creationix/nvm)
To use the correct version of Node.js for this application, via nvm:
```bash
cd cdp-example-node-backend
nvm use
```
## Local development
### Setup
Install application dependencies:
```bash
npm install
```
### Development
To run the application in `development` mode run:
```bash
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.
```bash
ncu -i
```
### Production
To mimic the application running in `production` mode locally run:
```bash
npm start
```
### Npm scripts
All available Npm scripts can be seen in [package.json](./package.json)
To view them in your command line run:
```bash
npm run
```
## API endpoints
| Endpoint | Description |
| :----------------------------- | :----------- |
| `GET: /health` | Health |
| `GET: /v1/entities` | Entities |
| `GET: /v1/entities/` | Entity by ID |
## Calling API endpoints
### Postman
A [Postman](https://www.postman.com/) 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](postman/cdp-example-node-backend.postman_collection.json)
- [CDP Node Backend Template Postman Environment](postman/cdp-example-node-backend.postman_environment.json)
## Docker
### Development image
Build:
```bash
docker build --target development --no-cache --tag cdp-example-node-backend:development .
```
Run:
```bash
docker run -e GITHUB_API_TOKEN -p 3008:3008 cdp-example-node-backend:development
```
### Production image
Build:
```bash
docker build --no-cache --tag cdp-example-node-backend .
```
Run:
```bash
docker run -e GITHUB_API_TOKEN -p 3001:3001 cdp-example-node-backend
```
## Licence
THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:
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.