Skip to content

Latest commit

 

History

History
60 lines (42 loc) · 2.05 KB

README.md

File metadata and controls

60 lines (42 loc) · 2.05 KB

Alexa Skill for New Zealand Earthquakes

Build Status

New Zealanders often ask themselves: Was that an earthquake, a truck going past, or just the wind? Now you can ask Alexa!

Examples:

  • "Alexa, ask kiwi quakes if this was an earthquake"

We acknowledge the awesome New Zealand GeoNet project and its sponsors EQC, GNS Science and LINZ, for providing data used in this app. Check their API and data policy.

Under the hood, it uses AWS Lambda functions deployed through the Serverless Framework.

Requirements

  • Node 6.x (latest version supported by AWS Lambda)
  • Alexa Ask CLI
  • A working AWS account

Setup

npm install

Now copy config.default.json to config.json and set your Google API key (required for geocoding lookups).

Usage

First, create two skills in Alexa: dev and prod. Then, adjust the skill ids and AWS profiles accordingly in package.json. More details can be found in the Alexa Starter Template

  • npm run deploy:dev: Deploys skill, model and function (dev stage)
  • npm run deploy:dev:sls: Deploys function (dev stage)
  • npm run deploy:dev:skill: Deploys skill (dev stage)
  • npm run deploy:dev:model: Deploys model (dev stage)
  • npm run deploy:prod: Deploys skill, model and function (prod stage)
  • npm run deploy:prod:sls: Deploys function (prod stage)
  • npm run deploy:prod:skill: Deploys skill (prod stage)
  • npm run deploy:prod:model: Deploys model (prod stage)

Note that utterances in models/ should be regenerated manually via util/generate-utterances.js at the moment.

Testing

Uses Mocha.

npm test