1.0.3 • Published 2 years ago

browser-link-for-port-apps v1.0.3

Weekly downloads
-
License
ISC
Repository
github
Last release
2 years ago

Login widget creates connection to Port app (using QR code, magnet link or simple copy-paste function). View demo.

Installation

Browser link for Port apps is a simple HTML widget (lightweight) - no additional packages needed. It runs in browser.

Prerequirements

Create dynamic link with one of four options on the Firebase platform. You don't need to create an entire dynamic link, only a dynamic_link URL is required. Other parameters are created by script in this repository.

How to run

  1. Copy two files 'js/browser-link-for-port-apps.js' and 'css/browser-link-for-port-apps.css' to your project.

  2. Include .js file into your header:

<script src="<path>/browser-link-for-port-apps.js"></script>
  1. Include .css file into your header:

Prerequirements

Create dynamic link with one of four options on Firebase platform. You dont need to create entire dynamic link, only dynamic_link url is required. Other parametes is created by script in this repository.

Implementation on website

Include JavaScript files to the project:

<script src="js/login.js"></script>

Create div section; where widget will be presented:

<div class="divqr">
   <section id="zeropass-port-qr"></section>
</div>

Call the render script:

<script>
 var androidData = {"apn":"<apn>",
                    "afl":"<link_to_play_store>",
                "version":"<min_sdk_version>"};

 var iosData = {"ibi":"<apple_store_id>",
                "isi":"<link_to_app_store>",
                "imv":<min_ios_version_integer>}

 var shortLinkURL = "<short_link>";
 var deepLinkURL = "<deep_link>";

 ZeroPassPortWidget.render(shortLinkURL,
                           deepLinkURL,
                           androidData,
                           iosData,
                           { 
                              userID: "<user_id>",
                              requestType: "<request_type>", //only ATTESTATION_REQUEST, PERSONAL_INFORMATION_REQUEST, FAKE_PERSONAL_INFORMATION_REQUEST, LOGIN allowed
                              url: "<url>"
                           },
                           document.querySelector('#zeropass-port-qr'));

</script>

Check example in index.html file

Acknowledgment

QR window design inspired by Anchor Link

License

MIT