@sudoplatform/sudo-secure-id-verification

Sudo Secure Id Verification JavaScript SDK

Project Setup

Cloning this repo

To clone this repo along with the submodule linkage execute this command:

git clone git@gitlab.tools.anonyome.com:platform/identity-verification/sudo-identity-verification-js.git --recurse-submodules

Getting the latest

git pull

Updating the submodule

cd test/sudo-identity-verification-test-data
git fetch
git log --oneline origin/master -3
git checkout -q <commit-id-to-move-to>

Installing Dependencies

yarn install

Build Solution

yarn build

Running Unit Tests

yarn unit-test

Running Integration Tests

Create a config directory under the root of the repo. In this directory add:

  • The configuration file for a Sudo Platform runtime instance. Name this file sudoplatformconfig.json
  • For a test registration key created in the Admin Console, create a file named register_key.id and add the key id.
  • For the same test registration key created in the Admin Console, save the file with the name register_key.private.

Note: DO NOT add the config directory or its contents into the git repo.

Then, run yarn integration-test

Release Procedure

Publish Internal

For new releases that contain new functionality we will publish internally first before publishing to GitHub.

To publish a new version of Sudo Identity Verification SDK for JavaScript for internal consumption:

  • Create a new tag from master branch with the following naming /alpha$/

Publish External

For new releases that contain bug fixes or that have been through a publish internal procedure and have been signed off.

To publish a new version of Sudo Identity Verification SDK for JavaScript to GitHub for external consumption:

  • Create a new tag from master with the release version. e.g. 1.0.0