/FingerprintAuthentication

Fingerprint Authentication for RFID transactions.

Primary LanguageJavaScriptGNU Lesser General Public License v3.0LGPL-3.0

FingerprintAuthentication

Final Year Project

Collaborators : @ParadoxInfinite @OsmanDsilva @Mithrandir98 @vadikrh

⚠️ WARNING :

If the hardware prerequisite for this project is not met, testing the program is not possible.

Prerequisites :

Pre-run setup :

  1. Install Node.js.
  2. Install MongoDB. [ preferably installed as a service ]
  3. Install web browser of your choice. [ Chrome/Firefox recommended ]
  4. Install MFS100 Client, ensure it is installed as a service.
  5. Ensure MongoDB service is running and ‘bankdb’ collection is present.
  • Open run [ Win + R ], run ‘cmd
  • In the Command Prompt, run ‘mongo’, if it gives a prompt, this means MongoDB is running.
  • If no prompt/error, in Command Prompt, run ‘mongod’ and in another Command Prompt run ‘mongo’. This should give a prompt, this means mongo is running.
  • To check if ‘bankdb’ exists or to create it, run ‘use bankdb’. This will create if the collection does not exist.
  • If Step C. is executed, do not close the prompt on which ‘mongod’ is running.

Running the program [ Easy method ] :

  1. Download and run one of the binaries from Releases page depending on the Operating System.
  2. In the browser, type ‘http://localhost:5000/' and it should land on the Index page of the program.
  3. If hardware prerequisites are not connected, this is the furthest one can reach.

Post this point, further steps have been made intuitive for the user.

Running the program [ Development method ]:

  1. Clone this repository
  2. In a Command Prompt/Terminal/Shell, cd (change directory) to the cloned folder.
  3. Run ‘npm install’ to install the dependencies required for the program.
  4. Once the dependencies are installed, run ‘npm start’. This will run the program on port 5000 on localhost.
  5. In the browser, type ‘http://localhost:5000/' and it should land on the Index page of the program.
  6. If hardware prerequisites are not connected, this is the furthest one can reach.

Post this point, further steps have been made intuitive for the user.

Issue reporting :

If you want to report an issue, follow these steps :

  1. Check for the issue first. If no existing issue address your issue, open a new issue.
  2. Issue must contain detailed description of the problem faced.
  3. Steps taken to encounter the error and steps to reproduce the error.
  4. Enviroment details such as Operating System(including build/version), MongoDB version etc.