zapp-pipes-packager

This project contains the packager system for building zapp pipes data source bundles in Zapp.

pre-requisite

• homebrew
• node ^8.x.x && npm ^5.5.0
  • brew install nvm
  • nvm install 8.11.3
  • nvm use 8.11.3
• yarn ^1.6.0
  • brew install yarn --without-node
• aws-cli
  • sudo easy_install pip
  • pip install awscli --upgrade --user
• run aws configure to set your aws credentials on your machine

You need to have a valid ZAPP_TOKEN in your environment variables visit https://accounts.applicaster.com to create one.

You will also need to log in to NPM.

Installation

• clone this repo
• install npm dependencies with yarn

Usage

In order to use the packager, you need the app version id from zapp:

• go to your app page in zapp
• press on the specific app version in order to get the app version id

Simply invoke the packager script with the app version id and an optional list of providers

yarn package app_version_id <provider1 provider2 provider3 ...>

the packager will automatically :

• pull the .env file configuration for the provided app_version_id and look for providers. If providers are also included in the command line, providers declared in the .env file will be ignored
• install the providers from their respective npm packages. providers must be valid npm packages. If the package is scoped in applicaster organization, then the package name should follow this pattern @applicaster/zapp-pipes-provider-{provider-name}, and the packager script is invoked with only {provider-name}. If the package is not applicaster-scoped, then the packager script needs to be invoked with the full package name.
• run each provider's test command
• render the bundle's index file
• run the test commands on the bundle
• build the bundle
• deploy it on s3.

At the end of the process, you will get the URL of the bundle from the standard output