@prove-identity/prove-auth

Prove Auth Web SDK

This SDK provides JavaScript client API to the Prove's authentication platform Prove Auth.

Building

• Make sure you have Node JS, npm, TypeScript installed:
  • Install node, preferably using nvm, current stable version is v20.2.0
  • Make sure to uninstall any old version on TypeScript compiler - npm uninstall tpc
  • Install TypeScript npm install typescript
  • Build the project from your IDE or CLI - npm run build

Running Samples

• Build the sdk first, then build the sample code:
  • Build SDK web bundle - npm run clean && npm run build && npm run bundle-dev
  • Build and start sample code - cd samples/basic; npm run build && npm run serve

Running Unit Tests

This project provides several options for running unit tests. Follow these instructions to execute the tests:

Standard Test Run

To run the standard test suite:

npm test

This command will execute all unit tests and display the results in your default web browser.

Running Tests with Node

If you need to run tests in a Node.js environment:

npm run test-with-node

This command will execute all unit tests and display the results in your terminal.

Using the Test Runner

To run integration tests using Test Runner:

npm run test-runner

This command uses Test Runner client to execute integration tests enabled for the Web SDK. Execution of integration tests depends on the Test Runner server components, which are part of (Garfield backend service)[https://gitlab.com/prove-identity/prove-auth/garfield], and must be started in advance using make test-localhost-up command in that repo.