porta-v3

Date 2021/12/27

Stores and Retrieves Log and Result Data for PortaMetrics

Getting started for developers

1. Copy porta-v3.env from \motionmetrics.net\i2l\Bamboo_Files\MMPro_Env\I2L-Staging and rename it as .env

2. Copy .npmrc from \motionmetrics.net\i2l\Bamboo_Files\MMPro_Env\I2L-Staging

3. Install all the dependencies with the command:

    npm ci

4. Verify Segmentation-Service-Python is running locally or as a Docker container at localhost:7199/fmsegmentation/v2/help

   • If it is not set up on your device, follow the installation steps outlined within the segmentation-service-python repository

5. Run Unit test

    npm test

6. Compile the typescript to javascript and run lint

    npm run-script build

7. Start the program

    npm start

Running Integration Tests

1. Copy the npm-qc-user-credentials.env from NAS, and save it to the IntegrationTest folder and rename it as .env

2. Change ROOT_DOMAIN to point to http://localhost:8080, if you are testing it locally.

3. Repeat Steps in "Getting started for developer" if you haven't done

4. Run the Integration Test:

    npm run-script integration-test

Run Docker

1. Run the docker command

docker run -it --name "porta-v3" --network host porta-v3

Commit Message Format - Angular Convention

(): │ │ │ │ │ └─⫸ Summary in present tense. Not capitalized. No period at the end. │ │ │ └─⫸ Commit Scope: animations|bazel|benchpress|common|compiler|compiler-cli|core| │ elements|forms|http|language-service|localize|platform-browser| │ platform-browser-dynamic|platform-server|router|service-worker| │ upgrade|zone.js|packaging|changelog|docs-infra|migrations| │ devtools │ └─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test see https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format for more details

Alternatively, you can use the module commitizen to help you format the commit message.

1. install commitizen

    npm install -g commitizen

2. making your repo commitizen-friendly

    commitizen init cz-conventional-changelog --save-dev --save-exact

3. commit your changes Simply use git cz or just cz instead of git commit when committing. You can also use git-cz, which is an alias for cz.

    git add .
    git cz

see https://github.com/commitizen/cz-cli for more details

Updating API Doc

1. Grab the porta-v3.json from mm-staging-openapi-definitions S3 bucket in motionmetrics-dev account

2. Update JSON accordingly

3. Ensure metadata is configured correctly under property

{
  Type: User defined,
  Key: x-amz-meta-apidoc-access,
  Value: edit
}

4. Upload the updated JSON to mm-staging-openapi-definitions in motionmetrics-dev account
5. Upload the same JSON to mm-prod-openapi-definitions in motionmetrics-prod account

Note:

We are currently using Node LTS v16.13.0