Giter Club home page Giter Club logo

verify-demo-app's Introduction

Verify Demo App

The demo application meant to illustrate how to integrate a Visitor Management System (VMS) with Verify APIs.

Contents




Quick Start

1.1 Install Node and NPM (skip this step if you have NPM installed)

For the demo application to run, you will need to install Node and NPM.

Follow the instructions given by the links below depending on your OS.

1.2 [For Windows only] - OpenSSL Installation (skip this step if you have OpenSSL installed)

For windows user, you are required to install the OpenSSL library in your computer in order to use myinfo-connector-nodejs library. Please refer to the OpenSSL installation guide here.

1.3 Run NPM install

Run the following command in the folder you unzipped the application:

npm install

1.4 Start the Application

Execute the following command to start the application:

npm start

Access the Application on Your Browser You should be able to access the sample application via the following URL:

http://localhost:3002

Demo Screenshot

How To Use

The application describes a demo Visitor Management System (VMS),

  • Files in your-vms-client and your-vms-server represent the VMS Client and Server respectively and can be modified.

  • Files in mock-server are for mocking SingPass Mobile and VERIFY Server flow and SHOULD NOT be modified.

URL & QR Code Generation

To enable Dynamic QR. Edit your-vms-server/app.js Look for let qrCodeParams. To enable static QR, uncomment and use these configurations:

  let qrCodeParams = {
    'qrType': 'static' 
    ...
  }

To enable dynamic QR, uncomment and use these configurations:

  let qrCodeParams = {
    'qrType': 'dynamic',
    ...
  }

Enable Payload Encryption & PKI Digital Signature

To enable payload encryption and signing. Edit your-vms-server/config/config.js. Look for Without encryption and signing, uncomment and use these configurations:

/* Without Encryption and Signing 
  Note: The sandbox environment is used for your testing when developing your prototype
*/
'ENVIRONMENT' : 'SANDBOX',
'TOKEN_URL' : 'https://sandbox.api.myinfo.gov.sg/sgverify/v2/token',
'PERSON_URL' : 'https://sandbox.api.myinfo.gov.sg/sgverify/v2/person',

To disable payload encryption and signing. Look for With encryption and signing, uncomment and use these configurations:

/* With Encryption and Signing 
  Note: The test environment is used for testing your application with the full security measures required in production
*/
'ENVIRONMENT' : 'TEST',
'TOKEN_URL' : 'https://test.api.myinfo.gov.sg/sgverify/v2/token',
'PERSON_URL' : 'https://test.api.myinfo.gov.sg/sgverify/v2/person',

MyInfo Connector NodeJS

This demo application is using the myinfo-connector-nodejs library. MyInfo Connector aims to simplify consumer's integration effort by providing an easy to use Javascript library to integrate into your application.

Reporting Issue

You may contact our support for any other technical issues, and we will respond to you within 5 working days.

verify-demo-app's People

Contributors

cs17 avatar yuejun92 avatar wjuno avatar cheongkahou avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.