# Introduction 

******Biometric Identification Version 1******

This application is used as part of 2 factor authentication where the second factor logs in the user using biometrics.
The application is divided into two portions; the desktop and mobile application.

# Getting Started

******Check documentation for detailed instructions*******

Desktop Application:
You will find this under the desktop_application folders

-Open in IDE of choice
-Run "npm install" in order to download all dependencies from package.json file
- (Optional)Run "npm run server" in the case that you just want to run the socket server
- Run "npm run start" to run both the socket server and the desktop application

Mobile Application:
You will find this under the mobile folder

-In your command prompt make sure you have done the pods setup before opening your Xcode
-Open Xcode Beta
-With Xcode Beta open the .xcworkspace file NOT the .xcodeproject
-Select a simulator
        - We use iPhone 8 as default , but feel free to choose any of your liking (one thing to note is that the U.I is currently adapted for iPhone 8 so the U.I might seem weird if done in other simulators)
        - If you want to test out the camera features you need to run it on an iPhone , which would require you to have a free apple developer account
-Press Command + B
	- This will build your application, it might take a while if its the first time you are doing it
-Press Command + R
	- This builds and runs the application

# License

 The MIT license 
 Copyright(c) Florida International University

#Acknowledgments

 Special thanks to our product owner **Rachelle Tobkes** as well as **Katherine Machin** for the mobile UI improvement