README.md

iProov Firebase Auth Extension

Welcome to the iProov Firebase Auth Extension!

The iProov Firebase Auth Extension allows you to use iProov Biometrics to authenticate your app's users with Firebase Auth.

It consists of:

• An installable Firebase Extension that you can add to your Firebase project.
• Mobile SDKs that you can add to your mobile app to perform the iProov face scan (iOS, Android and Flutter are currently supported).

Installing on Firebase

Follow the instructions here.

Installing locally on the Firebase Emulator

The extension can be emulated locally for development & testing.

1. Setup your machine with the emulator.

   IMPORTANT: You must setup GOOGLE_APPLICATION_CREDENTIALS, otherwise you will get errors when making requests through the extension.

   npm install -g firebase-tools
   export GOOGLE_APPLICATION_CREDENTIALS="/path/to/key.json" # Make sure you set this!

2. Start the emulator:

   cd extension/local    
   firebase emulators:start --project <project-id>

Deploying to Firebase

Deploying a local copy (for testing)

cd extension
firebase ext:dev:upload iproov/auth-iproov --local

Deploying to production

firebase ext:dev:upload iproov/auth-iproov