Alexa Skill starter project using AWS Lambda and Typescript

This is a simple starter project for Alexa skills using Typescript.

What is included in the project

• Default request handlers

• Extra handlers

• Error handlers

• Request interceptors

• Localization strings

Check lambda/custom/lib/strings.ts.

• Constants

Including the String keys, so you can have type safety everywhere.

Check lambda/custom/lib/constants.ts.

• Helper functions

Many helper functions which should reduce code duplication, and reduce the code needed to do common tasks.

Check lambda/custom/lib/helpers.ts.

• Local development

Contains an http server using express, which you can use with ngrok or servo.net during local development. Check the Local development section below for more details.

• Scripts

There are a few scripts inside package.json for building and deploying your lambda function using the ask-cli. Check the Developer tasks section below for more details.

• Tests

The project contains automated tests using jest. Check the __tests__ folder.

$ npm run test

If you want to include code coverage, run

$ npm run test:coverage

You can also start jest in watch mode:

$ npm run test:watch

• Travis CI and Codecov integrations

Pre-requisites

• Node.js
• Register for an AWS Account
• Register for an Amazon Developer Account
• Install and Setup ASK CLI

Installation

• Install the dependencies

$ npm install

Deployment

ASK CLI will create the skill and the Lambda function for you. The Lambda function will be created in us-east-1 (Northern Virginia) by default.

1. Navigate to the project's root directory. you should see a file named 'skill.json' there.

2. Deploy the skill and the Lambda function in one step by running the following command:

$ ask deploy

Local development

In order to develop locally and see your changes reflected instantly, you will need to create an SSH tunnel or expose somehow your local development server. There are several services that allow you to do this, for example ngrok or serveo.net.

Using servo.net

This is the easiest to setup

1. You need to have an SSH client installed, then simply run

$ ssh -R 80:localhost:3980 serveo.net
Forwarding HTTP traffic from [https://YOUR_URL]
Press g to start a GUI session and ctrl-c to quit.

2. Once you see the URL, copy it and go to your Skill console.

3. Open the Endpoint menu and select HTTPS

4. Under Default Region paste the previous URL you copied.

5. On the select box choose: My development endpoint is a sub-domain of a domain that has a wildcard certificate from a certificate authority.

6. You are done! Just run npm start to start the local server and begin testing the skill.

Using ngrok.io

1. Install ngrok

2. Run ngrok http 3980

3. Copy the URL and follow the same steps above from 3 to 6.

Developer tasks

To see the actual commands, check package.json.

Also check the ASK CLI Command Reference for more details on using the ASK CLI.

Testing

Taken from the official hello world project.

1. To test, you need to login to Alexa Developer Console, and enable the "Test" switch on your skill from the "Test" Tab.

2. Simulate verbal interaction with your skill through the command line (this might take a few moments) using the following example:

    $ ask simulate -l en-US -t "open greeter"
   
    ✓ Simulation created for simulation id: 4a7a9ed8-94b2-40c0-b3bd-fb63d9887fa7
   ◡ Waiting for simulation response{
     "status": "SUCCESSFUL",
     ...

3. Once the "Test" switch is enabled, your skill can be tested on devices associated with the developer account as well. Speak to Alexa from any enabled device, from your browser at echosim.io, or through your Amazon Mobile App and say :

   Alexa, start hello world
   

Customization

Taken from the official hello world project.

1. ./skill.json

   Change the skill name, example phrase, icons, testing instructions etc ...

   Remember than many information are locale-specific and must be changed for each locale (e.g. en-US, en-GB, de-DE, etc.)

   See the Skill Manifest Documentation for more information.

2. ./lambda/custom/index.ts

   Modify messages, and data from the source code to customize the skill.

3. ./models/*.json

   Change the model definition to replace the invocation name and the sample phrase for each intent. Repeat the operation for each locale you are planning to support.

4. Remember to re-deploy your skill and Lambda function for your changes to take effect.

   $ npm run deploy

License

Open sourced under the MIT license.