https://github.com/status-im/react-native-status-keycard

React Native library to interact with Status Keycard using NFC connection
https://github.com/status-im/react-native-status-keycard

android ios keycard nfc nfc-card-reader nfc-tag react-native status-im

Last synced: 5 days ago
JSON representation

React Native library to interact with Status Keycard using NFC connection

• Host: GitHub
• URL: https://github.com/status-im/react-native-status-keycard
• Owner: status-im
• License: mpl-2.0
• Created: 2018-11-22T16:45:17.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-09-16T11:38:31.000Z (about 2 months ago)
• Last Synced: 2024-09-17T10:43:56.711Z (about 2 months ago)
• Topics: android, ios, keycard, nfc, nfc-card-reader, nfc-tag, react-native, status-im
• Language: Java
• Homepage: https://keycard.status.im
• Size: 474 KB
• Stars: 27
• Watchers: 67
• Forks: 13
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# React Native Status Keycard [![npm version](https://badge.fury.io/js/react-native-status-keycard.svg)](https://badge.fury.io/js/react-native-status-keycard)

React Native library to interact with [Keycard](https://keycard.status.im/) using [Java SDK](https://github.com/status-im/status-keycard-java)

## Getting started

`$ npm install react-native-status-keycard --save`

### Mostly automatic installation

`$ react-native link react-native-status-keycard`

### Manual installation

Both iOS and Android are supported

#### Android

1. Open up `android/app/src/main/java/[...]/MainApplication.java`

  - Add `import im.status.ethereum.keycard.RNStatusKeycardPackage;` to the imports at the top of the file

  - Add `new RNStatusKeycardPackage()` to the list returned by the `getPackages()` method

2. Append the following lines to `android/settings.gradle`:

  	```

  	include ':react-native-status-keycard'

  	project(':react-native-status-keycard').projectDir = new File(rootProject.projectDir, 	'../node_modules/react-native-status-keycard/android')

  	```

3. Insert the following lines inside the dependencies block in `android/app/build.gradle`:

  	```

      compile project(':react-native-status-keycard')

  	```

4. Add `` to `android/app/src/main/AndroidManifest.xml` to enable NFC permission.

5. Make sure `minSdkVersion` is 18 in `android/build.gradle`.

## Usage

Take a look into [docs](./docs/usage.md)

For more usage examples, please refer to https://github.com/status-im/status-mobile (assuming you can read Clojure)

For Keycard API documention, please look into https://keycard.tech/docs/