phi-etl-fera-backend

Core delivery platform Node.js Backend Template.

• Requirements
  • Node.js
• Local development
  • Setup
  • Development
  • Production
  • Npm scripts
• API endpoints
• Calling API endpoints
  • Postman
• 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 phi-etl-fera-backend
nvm use

Local development

Setup

Install application dependencies:

npm install

Development

To run the application in development mode run:

npm run dev

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: /populateDb	creates collections in mongodb
GET: /updatePest	writes pest data into collection
GET: /updatePlant	writes plant data into collection

| POST: /search/plants | get plant info for seach input from user | | GET: /search/countries | writes plant data into collection |

| POST: /workflow | initiates workflow to get annex6 and annex11 rules for plant |

Master JSON files countries.json serviceFormat.json plant_annex6.json (Will be provided by DEFRA) plant_annex11.json (Will be provided by DEFRA)

The following transactional files are integral to the application, and currently being generated from the dump received from FERA. Post Inegration with FERA through the API's exposed by them, the following files will be generated automatically from the response from the APIs.

plant_name.json pest_name.json pest_plant_link.json pest_distribution.json pest_fcpd pest_pras plant_pest_reg

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

Docker

Development image

Build:

docker build --target development --no-cache --tag phi-etl-fera-backend:development .

Run:

docker run -e GITHUB_API_TOKEN -p 3008:3008 phi-etl-fera-backend:development

Production image

Build:

docker build --no-cache --tag phi-etl-fera-backend .

Run:

docker run -e GITHUB_API_TOKEN -p 3001:3001 phi-etl-fera-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.