react-native-eid-reader v0.0.0

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Mostly automatic installation
  • Manual installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

[]

The module/tool currently reads the contents of:

• Electronic/Biometric passports in BAC security mode.

• The Algerian eID card.

  A list of commonly used resources that I find helpful are listed in the acknowledgements.

Built With

• jMRTD - The library for reading the epassport chip LGPL 3.0 License.
• SCUBA - a Java based framework for programming smart card aware host applications LGPL 3.0 License.

Getting Started

Prerequisites

• node & npm
• React Native

Mostly automatic installation

1. Within your React Native project, open up a new terminal window and install the module:

$ npm install react-native-eid-reader --save

2. React Native requires linking native dependencies, excute the following in the terminal:

$ react-native link react-native-eid-reader

Manual installation

iOS

1. In XCode, in the project navigator, right click Libraries ➜ Add Files to [your project's name]
2. Go to node_modules ➜ react-native-eid-reader and add EidReader.xcodeproj
3. In XCode, in the project navigator, select your project. Add libEidReader.a to your project's Build Phases ➜ Link Binary With Libraries
4. Run your project (Cmd+R)<

Android

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

• Add import com.reactlibrary.EidReaderPackage; to the imports at the top of the file
• Add new EidReaderPackage() to the list returned by the getPackages() method

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

   include ':react-native-eid-reader'
   project(':react-native-eid-reader').projectDir = new File(rootProject.projectDir, 	'../node_modules/react-native-eid-reader/android')

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

   compile project(':react-native-eid-reader')

Usage

import EidReader from 'react-native-eid-reader';

// TODO: What to do with the module?
EidReader;

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the Apache License 2.0 License. See LICENSE for more information.

Contact

Hamza BOUKHTAM - @boukhtam_hamza - xu@live.fr

Project Link: React Native Electronic-Identity-Documents Reader module

Acknowledgements