https://github.com/defra/fcp-dal-upstream-mock
Git repository for service fcp-dal-upstream-mock
https://github.com/defra/fcp-dal-upstream-mock
backend cdp node service
Last synced: 12 months ago
JSON representation
Git repository for service fcp-dal-upstream-mock
- Host: GitHub
- URL: https://github.com/defra/fcp-dal-upstream-mock
- Owner: DEFRA
- License: other
- Created: 2025-04-11T09:26:01.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-07-02T12:05:29.000Z (12 months ago)
- Last Synced: 2025-07-03T00:04:20.461Z (12 months ago)
- Topics: backend, cdp, node, service
- Language: JavaScript
- Size: 837 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# fcp-dal-upstream-mock
Core delivery platform Node.js Backend Template.
- [Requirements](#requirements)
- [Node.js](#nodejs)
- [Local development](#local-development)
- [Setup](#setup)
- [Development](#development)
- [Testing](#testing)
- [Production](#production)
- [Npm scripts](#npm-scripts)
- [Update dependencies](#update-dependencies)
- [Formatting](#formatting)
- [Windows prettier issue](#windows-prettier-issue)
- [API endpoints](#api-endpoints)
- [Docker](#docker)
- [Development image](#development-image)
- [Production image](#production-image)
- [Dependabot](#dependabot)
- [SonarCloud](#sonarcloud)
- [Licence](#licence)
- [About the licence](#about-the-licence)
## Requirements
### Node.js
Please install [Node.js](http://nodejs.org/) `>= v22` and [npm](https://nodejs.org/) `>= v11`. 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 fcp-dal-upstream-mock
nvm use
```
## Local development
### Setup
Install application dependencies:
```bash
npm install
```
### Development
To run the application in `development` mode run:
```bash
npm run dev
```
### Testing
To test the application run:
```bash
npm run test
```
> NOTE: Contract testing is described separately [here](./test/contract/README.md).
### Production
To mimic the application running in `production` mode locally run:
```bash
node ./src
```
### 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
```
### Update dependencies
To update dependencies use [npm-check-updates](https://github.com/raineorshine/npm-check-updates):
> The following script is a good start. Check out all the options on
> the [npm-check-updates](https://github.com/raineorshine/npm-check-updates)
```bash
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:
```bash
git config --global core.autocrlf false
```
## API endpoints
More information about each logical area of the API can be found by accessing its associated schema.
| Endpoint | Description |
| :-------------------------- | :------------------------------------------------ |
| `GET: /health` | Basic platform health check |
| `GET: /schemata/person.yml` | Defines the API for `person` data at `/v1/person` |
## Docker
### Development image
Build:
```bash
docker build --target development --no-cache --tag fcp-dal-upstream-mock:development .
```
Run:
```bash
docker run -e PORT=3001 -p 3001:3001 fcp-dal-upstream-mock:development
```
### Production image
Build:
```bash
docker build --no-cache --tag fcp-dal-upstream-mock .
```
Run:
```bash
docker run -e PORT=3001 -p 3001:3001 fcp-dal-upstream-mock
```
## Dependabot
We have added an example dependabot configuration file to the repository. You can enable it by renaming
the [.github/example.dependabot.yml](.github/example.dependabot.yml) to `.github/dependabot.yml`
## SonarCloud
Instructions for setting up SonarCloud can be found in [sonar-project.properties](./sonar-project.properties)
## 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.