https://github.com/tankerhq/identity-js
https://github.com/tankerhq/identity-js
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/tankerhq/identity-js
- Owner: TankerHQ
- License: other
- Created: 2021-06-10T12:03:22.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2025-02-12T09:48:58.000Z (4 months ago)
- Last Synced: 2025-03-27T17:39:32.722Z (3 months ago)
- Language: TypeScript
- Homepage:
- Size: 592 KB
- Stars: 3
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[license-badge]: https://img.shields.io/badge/License-Apache%202.0-blue.svg
[license-link]: https://opensource.org/licenses/Apache-2.0
[actions-badge]: https://github.com/TankerHQ/identity-js/actions/workflows/tests.yml/badge.svg
[actions-link]: https://github.com/TankerHQ/identity-js/actions/workflows/tests.yml
[codecov-badge]: https://img.shields.io/codecov/c/github/TankerHQ/identity-js.svg?label=Coverage
[codecov-link]: https://codecov.io/gh/TankerHQ/identity-js
[last-commit-badge]: https://img.shields.io/github/last-commit/TankerHQ/identity-js.svg?label=Last%20commit&logo=github
[last-commit-link]: https://github.com/TankerHQ/identity-js/commits/master
[identity_npm-badge]: https://img.shields.io/npm/v/@tanker/identity.svg
[identity_npm-link]: https://npmjs.com/package/@tanker/identity
[![License][license-badge]][license-link]
[![Build][actions-badge]][actions-link]
[![Coverage][codecov-badge]][codecov-link]
[](identity_npm-link)
# Encryption SDKs for JavaScript
[Overview](#overview) · [Identity](#identity-management) · [Contributing](#contributing) · [License](#license)
## Overview
Tanker is an open-source solution to protect sensitive data in any application, with a simple end-user experience and good performance. No cryptographic skills are required to implement it.
## Identity management
End-to-end encryption requires that all users have cryptographic identities. The following packages help to handle them:
Tanker **Identity** is a server side package to link Tanker identities with your users in your application backend.
It is available in multiple languages. This repository only contains the Javascript version.
| Package | Version |
|:--------|:--------|
| [@tanker/identity][identity_npm-link] | [![identity_npm-badge]][identity_npm-link] |
## Contributing
We welcome feedback, [bug reports](https://github.com/TankerHQ/identity-js/issues), and bug fixes in the form of [pull requests](https://github.com/TankerHQ/identity-js/pulls).
To build the JavaScript SDKs yourself, please follow the steps below.
### Prerequisites
Install the lastest version of [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
Use this command to check the npm version installed on your system:
```bash
npm --version
```
### Install dependencies
Clone this repository:
```bash
git clone https://github.com/TankerHQ/identity-js.git
```
Install dependencies:
```bash
cd identity-js && npm install
```
### Test and lint
Our codebase uses the following ES6 features: `async` / `await`, `import` / `export`, and classes with flow for type-checking and with eslint for linting.
To check that the code is correct and to launch the tests in Node.js, use:
```bash
npm run proof
```
### Submit your pull request
Before submitting your pull request, please make sure that your changes pass the linters and that all the tests pass on your local machine.
For non-trivial changes, we highly recommend including extra tests.
When you're ready, submit your [pull request](https://github.com/TankerHQ/identity-js/pulls), targeting the `master` branch of this repository.
## License
The Tanker Identity SDK is licensed under the [Apache License, version 2.0](http://www.apache.org/licenses/LICENSE-2.0).