README

sls-plugin-platform-apps

David GitHub code size in bytes GitHub repo size npm npm npm npm NPM npm GitHub last commit npm collaborators

Serverless Framework Plugin to Deploy and Remove AWS Platform Apps

Installation

To install with npm, run this in your service directory:

npm install --save sls-plugin-platform-apps

Then add this to your serverless.yml

plugins:
  - sls-plugin-platform-apps

Configuration

To define Platform Apps, add a platformApps section like this to your serverless.yml:

custom:
  platformApps:
    gcm:
      name: "${self:service}-${self:provider.stage}"
      platform: GCM
      credential: "${self:custom.secrets.FIREBASE_SERVER_KEY}"

Command Line Usage

Your Platform Apps will be deployed automatically when you run:

sls deploy

To deploy all Platform Apps without deploying the Serverless service, use:

sls deploy platformApps

To deploy a single Platform App without deploying the Serverless service, use:

sls deploy platformApps --app [appName]

To remove a single Platform App without removing the Serverless service, use:

sls remove platformApps --app [appName]

To remove all Platform Apps without removing the Serverless service, use:

sls remove platformApps

TODO

Add tests