status-im
/
react-native-status-keycard
mirror of https://github.com/status-im/react-native-status-keycard.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
React Native library to interact with Status Keycard using NFC connection https://keycard.status.im
131 Commits 22 Branches 62 Tags 966 KiB
Java 54.1%
Swift 39.8%
Objective-C 5.4%
Ruby 0.6%
JavaScript 0.1%
Go to file
Andrea Franz 9d1c14e1ff use global thread for keycard interactions 2020-12-08 11:20:31 +01:00
android add startNFC/stopNFC 2020-12-04 09:21:08 +03:00
docs Add nfc state events 2020-03-05 14:54:40 +02:00
ios use global thread for keycard interactions 2020-12-08 11:20:31 +01:00
.gitattributes initial commit 2018-11-22 19:49:00 +03:00
.gitignore add base ios files 2020-11-24 12:29:25 +01:00
LICENSE Rename LICENSE.md to LICENSE 2018-12-22 21:15:52 +03:00
README.md update docs 2019-05-02 22:25:25 +03:00
index.js rename module, restore export 2020-12-01 14:55:31 +03:00
package.json rollback package.json 2020-12-01 13:48:24 +01:00
react-native-status-keycard.podspec add Keycard dependency 2020-12-01 11:41:22 +01:00

README.md

React Native Status Keycard npm version

React Native library to interact with Keycard using Java SDK

Getting started

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

Mostly automatic installation

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

Manual installation

Android is the only platform supported by now.

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

  1. 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')

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

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

  3. Add <uses-permission android:name="android.permission.NFC"/> to android/app/src/main/AndroidManifest.xml to enable NFC permission.

  4. Make sure minSdkVersion is 18 in android/build.gradle.

Usage

Take a look into docs

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

For Keycard API documention, please look into https://status.im/keycard_api/