IronCore Labs SDK for Browser Based JavaScript Applications
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.travis_scripts
integration
src
webpack
.babelrc
.eslintignore
.eslintrc
.gitignore
.travis.yml
CHANGELOG.md
LICENSE
README.md
RELEASING.md
globals.d.ts
ironweb.d.ts
karma.conf.js
nightwatch.json
package.json
tsconfig.json
tslint.json
yarn.lock

README.md

IronCore Labs JavaScript SDK

Build Status NPM Version

SDK for using IronCore from your browser-based JavaScript application. Read our documentation for further information about how to integrate this library into your client side application.

Installation

npm install @ironcorelabs/ironweb

Quickstart

Two quick-starts are available on the documentation site. These quick-starts will guide you through getting started with the IronWeb SDK in either a vanilla JS, React , or Angular codebase.

Types

This library contains a TypeScript definitions file which shows the available classes and methods for this SDK.

Local Development

Unit Testing and Linting

This repo uses NPM scripts in order to run all tests and linting. You can run both the unit tests and linting together by running yarn test.

Linting

TSLint and ESLint are used to run linting on all source code. In addition this repo has a Prettier configuration to auto-format source code upon save. Prettier should be configured within your IDE before contributing to this project.

yarn run lint

Unit Testing

This repo uses Karma and Jasmine for all unit testing. The unit tests are run using a headless version of Chrome to verify that all tests work in a browser-based environment.

yarn run unit

To run a subset of the tests you can use the -t option of Jest to only run tests whose name matches the provided value

yarn run unit --filter GroupCrypto

This library also has minimums for unit test code coverage in order to pass. These coverage minimums are configured within the karma.conf.js file and determine what the minimum % of code coverage is for various metrics before the unit tests will pass.