{"id":28541663,"url":"https://github.com/defra/apha-integration-bridge","last_synced_at":"2026-05-19T05:44:36.454Z","repository":{"id":296166684,"uuid":"992491783","full_name":"DEFRA/apha-integration-bridge","owner":"DEFRA","description":"Git repository for service apha-integration-bridge","archived":false,"fork":false,"pushed_at":"2025-09-18T07:47:14.000Z","size":306,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-18T09:37:36.509Z","etag":null,"topics":["backend","cdp","node","service"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DEFRA.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-05-29T08:39:29.000Z","updated_at":"2025-09-18T07:45:30.000Z","dependencies_parsed_at":"2025-05-29T09:46:13.751Z","dependency_job_id":"07ccea4a-585c-4433-a2f5-4a0e8e17c4f0","html_url":"https://github.com/DEFRA/apha-integration-bridge","commit_stats":null,"previous_names":["defra/apha-integration-bridge"],"tags_count":31,"template":false,"template_full_name":null,"purl":"pkg:github/DEFRA/apha-integration-bridge","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DEFRA%2Fapha-integration-bridge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DEFRA%2Fapha-integration-bridge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DEFRA%2Fapha-integration-bridge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DEFRA%2Fapha-integration-bridge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DEFRA","download_url":"https://codeload.github.com/DEFRA/apha-integration-bridge/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DEFRA%2Fapha-integration-bridge/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279000663,"owners_count":26082817,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-08T02:00:06.501Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backend","cdp","node","service"],"created_at":"2025-06-09T20:09:32.146Z","updated_at":"2026-05-19T05:44:36.433Z","avatar_url":"https://github.com/DEFRA.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# APHA: Integration Bridge\n\nCore delivery platform Node.js Backend Template.\n\n- [APHA: Integration Bridge](#apha-integration-bridge)\n  - [Requirements](#requirements)\n    - [Node.js](#nodejs)\n  - [Local development](#local-development)\n    - [Environment variables](#environment-variables)\n    - [Setup](#setup)\n    - [Development](#development)\n    - [Testing](#testing)\n    - [Production](#production)\n    - [Npm scripts](#npm-scripts)\n    - [Update dependencies](#update-dependencies)\n    - [Formatting](#formatting)\n      - [Windows prettier issue](#windows-prettier-issue)\n  - [API endpoints](#api-endpoints)\n  - [Development helpers](#development-helpers)\n    - [MongoDB Locks](#mongodb-locks)\n    - [Proxy](#proxy)\n  - [Docker](#docker)\n    - [Development image](#development-image)\n    - [Production image](#production-image)\n    - [Docker Compose](#docker-compose)\n    - [Dependabot](#dependabot)\n    - [SonarCloud](#sonarcloud)\n  - [Licence](#licence)\n    - [About the licence](#about-the-licence)\n\n## Requirements\n\n### Node.js\n\nPlease install [Node.js](http://nodejs.org/) `\u003e= v22` and [npm](https://nodejs.org/) `\u003e= v11`. You will find it\neasier to use the Node Version Manager [nvm](https://github.com/creationix/nvm)\n\nTo use the correct version of Node.js for this application, via nvm:\n\n```bash\ncd apha-integration-bridge\nnvm use\n```\n\n## Local development\n\nIn-order to run this application locally, you will need to register and obtain a login token for the Oracle Container Registry.\n\nYou can find the instructions on how to do this in the [Oracle Container Registry documentation](https://container-registry.oracle.com/).\n\nOnce you have obtained your personal access token (in your Oracle Container Registry account and NOT in an Oracle Cloud account), you can log in to the Oracle Container Registry by running `docker login container-registry.oracle.com` and providing your email address as the username and your personal access token as the password.\n\nTest your login by pulling the OracleDB image:\n\n```bash\ndocker pull container-registry.oracle.com/database/free:latest\n```\n\nNote: if you were already running the docker container you will need to compose it again with `npm run compose:up` and then it will also include the oracle DB.\n\n### Environment variables\n\nIn local development, we follow NextJS convention of using a `.env.local` file to store environment variables. All necessary defaults are provided inside\nthe `.env` file.\n\n### Setup\n\nInstall application dependencies:\n\n```bash\nnpm ci\n```\n\n### Development\n\nTo run the application in `development` mode run:\n\nStart the local development dependencies by running the following command:\n\n```bash\nnpm run compose:up\n```\n\n```bash\nnpm run dev\n```\n\n### Testing\n\nIn-order to run the tests locally, against test containers that run the free version of OracleDB, you will need to install the \"OracleDB Instant Client libraries\".\nYou can find the instructions on how to install them in the [OracleDB documentation](https://www.oracle.com/database/technologies/instant-client/downloads.html).\n\nOnce this is done, create a `.env.test.local` file at the root of the project, with the location of the \"OracleDB Instant Client libraries\". For example:\n\n```bash\nORACLE_CLIENT_LIB_DIR=/Users/yourusername/Downloads/instantclient_23_3\n```\n\nThen you can run the tests with:\n\n````\n\nTo test the application run:\n\n```bash\nnpm t\n````\n\n### Production\n\nTo mimic the application running in `production` mode locally run:\n\n```bash\nnpm start\n```\n\n### Npm scripts\n\nAll available Npm scripts can be seen in [package.json](./package.json).\nTo view them in your command line run:\n\n```bash\nnpm run\n```\n\n### Update dependencies\n\nTo update dependencies use [npm-check-updates](https://github.com/raineorshine/npm-check-updates):\n\n\u003e The following script is a good start. Check out all the options on\n\u003e the [npm-check-updates](https://github.com/raineorshine/npm-check-updates)\n\n```bash\nncu --interactive --format group\n```\n\n### Formatting\n\n#### Windows prettier issue\n\nIf you are having issues with formatting of line breaks on Windows update your global git config by running:\n\n```bash\ngit config --global core.autocrlf false\n```\n\n## API endpoints\n\n| Endpoint             | Description                    |\n| :------------------- | :----------------------------- |\n| `GET: /health`       | Health                         |\n| `GET: /example    `  | Example API (remove as needed) |\n| `GET: /example/\u003cid\u003e` | Example API (remove as needed) |\n\n## Development helpers\n\n### MongoDB Locks\n\nIf you require a write lock for Mongo you can acquire it via `server.locker` or `request.locker`:\n\n```javascript\nasync function doStuff(server) {\n  const lock = await server.locker.lock('unique-resource-name')\n\n  if (!lock) {\n    // Lock unavailable\n    return\n  }\n\n  try {\n    // do stuff\n  } finally {\n    await lock.free()\n  }\n}\n```\n\nKeep it small and atomic.\n\nYou may use **using** for the lock resource management.\nNote test coverage reports do not like that syntax.\n\n```javascript\nasync function doStuff(server) {\n  await using lock = await server.locker.lock('unique-resource-name')\n\n  if (!lock) {\n    // Lock unavailable\n    return\n  }\n\n  // do stuff\n\n  // lock automatically released\n}\n```\n\nHelper methods are also available in `/src/helpers/mongo-lock.js`.\n\n### Proxy\n\nWe are using forward-proxy which is set up by default. To make use of this: `import { fetch } from 'undici'` then\nbecause of the `setGlobalDispatcher(new ProxyAgent(proxyUrl))` calls will use the ProxyAgent Dispatcher\n\nIf you are not using Wreck, Axios or Undici or a similar http that uses `Request`. Then you may have to provide the\nproxy dispatcher:\n\nTo add the dispatcher to your own client:\n\n```javascript\nimport { ProxyAgent } from 'undici'\n\nreturn await fetch(url, {\n  dispatcher: new ProxyAgent({\n    uri: proxyUrl,\n    keepAliveTimeout: 10,\n    keepAliveMaxTimeout: 10\n  })\n})\n```\n\n## Docker\n\n### Development image\n\nBuild:\n\n```bash\ndocker build --target development --no-cache --tag apha-integration-bridge:development .\n```\n\nRun:\n\n```bash\ndocker run -e PORT=3001 -p 3001:3001 apha-integration-bridge:development\n```\n\n### Production image\n\nBuild:\n\n```bash\ndocker build --no-cache --tag apha-integration-bridge .\n```\n\nRun:\n\n```bash\ndocker run -e PORT=3001 -p 3001:3001 apha-integration-bridge\n```\n\n### Docker Compose\n\nA local environment with:\n\n- Localstack for AWS services (S3, SQS)\n- Redis\n- MongoDB\n- This service.\n- A commented out frontend example.\n\n```bash\ndocker compose up --build -d\n```\n\n### Dependabot\n\nWe have added an example dependabot configuration file to the repository. You can enable it by renaming\nthe [.github/example.dependabot.yml](.github/example.dependabot.yml) to `.github/dependabot.yml`\n\n### SonarCloud\n\nInstructions for setting up SonarCloud can be found in [sonar-project.properties](./sonar-project.properties)\n\n## Licence\n\nTHIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:\n\n\u003chttp://www.nationalarchives.gov.uk/doc/open-government-licence/version/3\u003e\n\nThe following attribution statement MUST be cited in your products and applications when using this information.\n\n\u003e Contains public sector information licensed under the Open Government license v3\n\n### About the licence\n\nThe Open Government Licence (OGL) was developed by the Controller of Her Majesty's Stationery Office (HMSO) to enable\ninformation providers in the public sector to license the use and re-use of their information under a common open\nlicence.\n\nIt is designed to encourage use and re-use of information freely and flexibly, with only a few conditions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdefra%2Fapha-integration-bridge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdefra%2Fapha-integration-bridge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdefra%2Fapha-integration-bridge/lists"}