0.1.0 • Published 4 years ago

@amply-media/amply-push-module v0.1.0

Weekly downloads
9
License
-
Repository
-
Last release
4 years ago

Project Title

Amply Push Library

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Usage Requirements

This library was designed to work within the existing AWS infrastructure we have established. As such, it is reliant on a few of our established standards.

First off, the project needs to be using Cloudfront or Nginx or some other service able to proxy requests. That service needs to be equipped to handle the following endpoints:

  • /pn/* - to handle the save, push, etc. requests sent to Glassfish
  • /ia* - handles images from Glassfish
  • /ic* - handles images from Glassfish
  • manifest.json - domain messaging credentials served by Glassfish
  • service_worker.js - the actual service worker handling the push service

Installing the Library

Currently the library can be used in two ways:

  1. Installing the git repository itself as an npm module
  2. Linking to the bundled JS file in an S3 bucket

Using the Library

The push library exposes four methods to the window which can be used by the frontend as necessary:

  1. amply_push.promptAllow() - triggers the system allow prompt and registers the allow
  2. amply_push.unsubscribe() - unsubscribes the user and removes the relevant entires in local storage
  3. amply_push.sendPush() - sends a sample push to the user
  4. amply_push.getSubscriptionInfo() - returns a string containing the user's relevant subscription ID and other data

Deployment

In progress

0.1.0

4 years ago

0.0.1

4 years ago