belts-csv-v3

Date 2021/01/20

Allows User to download CSV for BeltMetrics

API Document

https://apidocs.metricsmanagerstaging.com/belts-csv-v3/

Getting started for developer

1. Copy belts-csv-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. Run unit test

    npm test

5. Download the tgz file for the appdynamics library from NAS to the root folder. Make sure that this tgz file is only for local testing, so any code lines related to this must not be committed. (eg: package.json, package-lock.json) If you want to know more for this step, please go to https://bitbucket.org/motionmetricsdev/npm-mmpro-apm/src/master/README.md

    For Windows OS, appdynamics-nodejs-standalone-windows-x64-v16-21.9.0.8019.0.tgz in \\motionmetrics.net\i2l\Bamboo_Files\AppDynamics\Agents\win

    For MacOS or Linux, appdynamics-nodejs-standalone-linux-x64-v16-21.9.0.8019.0.tgz in \\motionmetrics.net\i2l\Bamboo_Files\AppDynamics\Agents\linux

6. Install the appdynamics library from the tgz file downloaded from the earlier step.

    npm install (tgz file name)

7. Compile the typescript to javascript and run lint

    npm run-script build

8. Start the program

    npm start

9. Run the project in debug mode (VSC)
   • npm run-script serve-debug
   • press F5
   • select the first option

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

Running Integration Tests

1. Copy the npm-qc-user-credentials.env from NAS ~/motionmetrics.net//UBC_I2L_Bamboo_data/MMPro_Env/QC/I2L-Staging/npm-qc-user-credentials.env, and save it to the IntegrationTest folder and rename it as .env

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

3. Run the Integration Test

    npm run-script integration-test

Releasing APIdoc

1. Install apidoc if you haven't

    npm install -g apidoc

2. Run the below command in the vs code terminal

    apidoc -i ./ -o apidoc/ -f ".*\.ts$" -e node_modules/ -e apidoc/

3. Open apidoc folder of your project in file explorer or finder
4. Verify the correctness of the content by opening index.html
5. Copy and paste the content in the folder to the project folder in \\motionmetrics.net\i2l\Bamboo_Files\APIDocs
6. New version will be pushed to apidoc.metricsmanagerstaging.com at midnight

Note

We are currently using Node LTS v16.13.0