scp-component-store-selling-features-domain-model

Establish environment variables (workstation installation)

Copy the .env.example file with default/sample environment variables for development to .env. Examine the variables and edit as necessary/appropriate for your workstation environment.

cp .env.example .env

Installation

First, make sure you are logged-in to the private NPM registry:

npm adduser --registry=https://registry.npmjs.org/ --scope=@aptos-scp

Then install the dependency packages:

npm install

Building the component library

First, make sure you've followed the instructions in the Installation section so you're logged into the private NPM registry and have installed dependency packages.

Then, to build the component library:

$ npm run build

You can then also run tests and coverage:

$ npm run test
$ npm run test:ci

Debugging

To setup a mocha test configuration in WebStorm, do the following:

1. Open the project in WebStorm.
2. At the top right of the project window, choose Edit Configurations....
3. Click the "+" symbol to add a new configuration, and choose Mocha.
4. Select the appropriate node interpreter. If using NVM, this should be something like, ~/.nvm/versions/node/v10.15.3/bin/node.
5. Make sure the project root is set as the working directory.
6. Set Extra Mocha Options to --no-opts --no-config (defensive - to ensure use of only package.json options).
7. Set Test file patterns to test-js/**/*.spec.js.
8. Save the configuration, then run or debug.

Publishing changes

To publish a new version to the NPM registry:

1. Do these steps only on the master branch -- that is, not on a feature branch. Feature branches should be merged to master before these steps.

2. Commit and push the changes (on master).

3. Update the version of the package using one of the following:

   npm version patch

   or

   npm version minor

   or one of the other variations (see npm-version)

4. Push the version commit and all version tags to trigger the CircleCI build that will build and publish the updated component:

   git push origin master --follow-tags

   or

   From WebStorm or IntelliJ make sure that the Push Tags check-box is checked, when you push changes.

When the build in Circle CI sees the version tag, it will publish the changes to the NPM repository.

License

Please see LICENSE.md.