Data Capture Service

Data Capture Service is an API that returns data about an application for compensation. Back-office API for the Apply service. Consumed by Cica Web.

Prerequisites

• Windows machine running docker desktop.
• You have Node Version Manager (NVM) installed globally. ^{(recommended, not required)}
• You have NPM ">=10.8.2" installed globally.
• You have Node ">=24.13.0" installed globally.
• You have the Postgres create-tables.sql file in a sibling directory named postgres-scripts (this mapping is defined in the docker-compose.yml file)

Installing Data Capture Service

Make sure that this repo is installed in a sibling directory to Cica Web. This directory structure is already configured in the docker-compose.yml file that are used to run the containers.

Clone the data-capture-service repo, and npm install

Using Data Capture Service

In order to fully run and use the API, you will need to clone and install the Cica Web. The neccessary docker-compose.yml file is found in the dev-utilities repo.

This Docker Compose configuration will assume that there is a cica-web, and data-capture-service directory, both with the respective installed repos in them for it to run correctly.

Full instructions on the required directory structure and configuration is found in the Docker-compose-setup-for-CW,-DCS,-Postgres Utilities Wiki article ^{(private repo)}.

To build and run the API, run these commands:

• docker-compose -f docker-compose.dev build
• docker-compose -f docker-compose.dev up

Once it is built and running, navigate to http://localhost:3100/docs to use the API Swagger UI.

Container scanning

A trivy.openvex.json file has been to ignore CVE-2023-45853 during trivy container scanning.. see the WIKI for more information.

Contributors

Thanks to the following people who have contributed to this project:

• @armoj
• @neil-stephen-mcgonigle
• @BarryPiccinni
• @sinclairs
• @stephenjmcneill1971
• @tjbburton

License

This project uses the following license: MIT.