# 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)
* [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
$ 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.

## Documentation
You can find documentation on API [here](https://docs.regulaforensics.com/ionic-face).

## Additional information
If you have any technical questions, feel free to [contact](mailto:support@regulaforensics.com) us or create issues [here](https://github.com/regulaforensics/ionic-native-face-api/issues).
