DPX Product Engine

Description

DPX Product Engine is a powerful and flexible application designed to manage and optimize product data. It provides a comprehensive set of tools for product data management, including data import/export, validation, and reporting.

Development Setup

Prerequisites

• Node.js (version 22.0.0 or higher)
• npm (version 8.0.0 or higher)

Installation

1. Clone the repository:

   git clone https://github.com/nib-group/dpx-product-engine.git

2. Navigate to the project directory:

   cd dpx-product-engine

3. Install the dependencies (make sure you're on the correct npm versio):

   nvm use
   npm install

Running in Development Mode

To start the application in development mode, run the following command:

npm run dev

Running Tests

To run the tests, use the following command:

npm test

Linting

To lint the code, use the following command:

npm run lint

To automatically fix linting errors, use:

npm run lint:fix

Building the Project

To build the project, use the following command:

npm run build

Urls

kaos: https://dpx-product-engine.kaos.nibit.com.au/

branch https://dpx-product-engine-phisl-xxx.kaos.nibit.com.au/

Usage

Provide detailed instructions on how to use the application, including examples and screenshots if necessary.

Retrieve endpoint Request Parameters

| Parameter | Type | Required | Default | Description | |----------------|--------|----------|---------|--------------------------------------------------------------------------| | variationID | string | No | None | Optional identifier for a specific variation. | | asset | string | Yes | None | The asset identifier to search for, e.g. IWHIWeb. | | effectiveDate| string | No | Now | The time value for when to execute the product rules. Defaults to now. | | visaSubclass | string | No | None | Optional visa-related parameter. | | scale | string | No | None | Optional scaling factor. | | dateOfBirth | string | No | None | Date of birth, if relevant to the search. |

e.g. http://localhost:8080/api/retrieve?asset=nibWorkers&variationID=V011&effectiveDate=2025-04-04T12:00:00Z&visaSubclass=457&scale=standard&dateOfBirth=1990-06-15

License

This project is licensed under the MIT License. See the LICENSE file for details.