No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.idea Review changes Jul 26, 2018
public remove fullstory Aug 2, 2018
src Changed cropping mode to automatic Aug 8, 2018
.env idscan go web implementation Aug 8, 2018
.gitignore idScanGo - Web v1.0.0 Jul 24, 2018
HTML_Workflow.png
README.md Modified documentation Aug 16, 2018
package-lock.json
package.json Review changes Jul 26, 2018
yarn.lock Code review Jul 19, 2018

README.md

Acuant idScanGo Web

Setup

This project works well with Node JS 6.10 and above. Please ensure that you have it installed. If you don't, please follow up this link.

Installation and Running

  • Step 1 - Start by downloading or cloning this repository
  • Step 2 - Open up the terminal and proceed to the project's directory
  • Step 3 - run npm install. This command will install all the required dependencies.
  • Step 4 - run npm run start. The project will start running on http://localhost:3000 (default address).

For setting up the app you have to explicitly set Environment variables in .env file that you can find in this folder.

These are the available environment variables that you'll find in the file.

PUBLIC_URL=https://acuantwebapps.com/idscangoweb/
REACT_APP_BASENAME=/idscangoweb
REACT_APP_ID_SCAN_GO_API=https://services.assureid.net
REACT_APP_FACE_API=https://frm.acuant.net
REACT_APP_AUTH_METHOD=Basic
REACT_APP_USER_NAME=
REACT_APP_USER_PASSWORD=
REACT_APP_SUBSCRIPTION_ID=
REACT_APP_SENTRY_SUBSCRIPTION_ID=

REACT_APP_SENTRY_SUBSCRIPTION_ID is optional. PUBLIC_URL is the URL of your app.

*IMPORTANT*

If you're deploying the App to a sub-folder on the server, you need to explicitly set REACT_APP_BASENAME env var. Otherwise the app won't work. This applications uses virtual routes that are set by React Router. React Router assumes that the App will be available at the root of the domain.

If you want to start the project on a different port, you can always add environment variables. Example: PORT=80 npm start will start the Application on the port :80.

Building for deployment

In general, React apps are static and built by running npm run build. This will create the build directory inside the project's folder. You can upload the build folder via FTP, SSH or even sync it with any S3 Bucket. Remember to change the PUBLIC_URL and REACT_APP_BASENAME env variables accordingly in the .env file.

idScan GO Web Workflow Diagram