https://github.com/ironcorelabs/ironweb
IronCore Labs SDK for Browser Based JavaScript Applications
https://github.com/ironcorelabs/ironweb
cryptography proxy-re-encryption transform-encryption wasm webassembly
Last synced: 11 months ago
JSON representation
IronCore Labs SDK for Browser Based JavaScript Applications
- Host: GitHub
- URL: https://github.com/ironcorelabs/ironweb
- Owner: IronCoreLabs
- License: agpl-3.0
- Created: 2019-01-15T16:42:30.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2025-06-16T22:53:52.000Z (12 months ago)
- Last Synced: 2025-06-16T23:29:19.916Z (12 months ago)
- Topics: cryptography, proxy-re-encryption, transform-encryption, wasm, webassembly
- Language: TypeScript
- Homepage: https://ironcorelabs.com/docs
- Size: 1.8 MB
- Stars: 14
- Watchers: 5
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# IronCore Labs JavaScript SDK
[](https://www.npmjs.com/package/@ironcorelabs/ironweb)
SDK for using IronCore from your browser-based JavaScript application. Read [our documentation](https://docs.ironcorelabs.com) for further information about how to integrate this library into your client side application.
## Installation
`npm install @ironcorelabs/ironweb`
## Quickstart
Three quick-starts are available on the [documentation site](https://ironcorelabs.com/docs/data-control-platform/javascript/overview/). These quick-starts will guide you through getting started with the IronWeb SDK in either a [vanilla JS](https://ironcorelabs.com/docs/data-control-platform/javascript/vanilla-javascript/), [React](https://ironcorelabs.com/docs/data-control-platform/javascript/react/) , or [Angular](https://ironcorelabs.com/docs/data-control-platform/javascript/angular/) codebase.
## Types
This library contains a [TypeScript definitions](ironweb.d.ts) 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](https://palantir.github.io/tslint/) and [ESLint](https://eslint.org/) are used to run linting on all source code. In addition this repo has a [Prettier](https://prettier.io) 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 [jest](https://jestjs.io/) and [nightwatch](https://nightwatchjs.org/) 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 GroupCrypto`
Copyright (c) 2022 IronCore Labs, Inc.
All rights reserved.