Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/regulaforensics/ionic-native-face-api
https://github.com/regulaforensics/ionic-native-face-api
Last synced: 29 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/regulaforensics/ionic-native-face-api
- Owner: regulaforensics
- Created: 2021-02-15T12:59:48.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-31T11:55:42.000Z (7 months ago)
- Last Synced: 2024-05-31T22:37:40.495Z (7 months ago)
- Language: TypeScript
- Size: 2.34 MB
- Stars: 3
- Watchers: 4
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Regula Face API (Ionic version)
Face API is a framework that is used for face matching, recognition and liveness detection.
# Contents
* [How to build the demo application](#how-to-build-the-demo-application)
* [How to use offine match](#how-to-use-offine-match)
* [Documentation](#documentation)
* [Additional information](#additional-information)
## How to build the demo application
1. Download or the clone current repository using the command `git clone https://github.com/regulaforensics/ionic-native-face-api.git`.
2. Run the following commands within the root directory:
```bash
$ cd example
$ npm install
$ npx jetify
$ ionic cordova prepare
```
3. Android:
* Run `ionic cordova run android` inside example folder - this is just one way to run the app. You can also run it directly from within Android Studio.
4. iOS:
* Run `ionic cordova run ios` inside example folder - this is just one way to run the app. You can also run it directly from within Xcode.
## How to use offine match
1. Place a license that supports offline match at `src/assets/regula.license`.
2. Change `android-packageName` and `ios-CFBundleIdentifier` in `config.xml` if required by your license.
3. Run the following commands:
```bash
ionic cordova plugin remove cordova-plugin-face-core
ionic cordova plugin add @regulaforensics/cordova-plugin-face-core-match
ionic cordova prepare
```
4. Turn off the internet and run the app.
## Documentation
You can find documentation on API [here](https://docs.regulaforensics.com/develop/face-sdk/mobile).
## Additional information
If you have any technical questions, feel free to [contact](mailto:[email protected]) us or create issues [here](https://github.com/regulaforensics/ionic-native-face-api/issues).