Skip to content

mramshaw/skill-sample-nodejs-fact

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Regions: 🇯🇵

Build An Alexa Fact Skill 🇺🇸

This Alexa sample skill is a template for a basic fact skill. Provided a list of interesting facts about a topic, Alexa will select a fact at random and tell it to the user when the skill is invoked.

If you would like to see an example of this skill in action, you can enable the Gloucester Facts from the Alexa Skill Store.

If this is your first time here, you're new to Alexa Skills Development, or you're looking for more detailed instructions, click the Get Started button below:

Be sure to take a look at the Additional Resources at the bottom of this page!

About

Note: The rest of this readme assumes you have your developer environment ready to go and that you have some familiarity with CLI (Command Line Interface) Tools, AWS, and the ASK Developer Portal. If not, click here for a more detailed walkthrough.

Usage

Alexa, ask Space Facts for a fact
	>> Here's your fact: A year on Mercury is just 88 days long.

Alexa, start Space Facts

Repository Contents

Setup w/ ASK CLI

Pre-requisites

Installation

  1. Clone the repository.

    $ git clone https://github.com/alexa/skill-sample-nodejs-fact/
  2. Initialize the ASK CLI by Navigating into the repository and running npm command: ask init. Follow the prompts.

    $ cd skill-sample-nodejs-fact
    $ ask init
  3. Install npm dependencies by navigating into the /lambda/custom directory and running the npm command: npm install

    $ cd lambda/custom
    $ npm install

    If desired, delete the package-lock.json file first so as to verify and test with latest npm versions:

    $ rm package-lock.json

Deployment

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

  1. Deploy the skill, interaction model and lambda function in one step by running the following command:

    $ ask deploy

[This may take a few minutes.]

Testing

  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 using the following example:

     $ ask simulate -l en-GB -t "start space facts"
    
     ✓ 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 space facts
    

Customization

Once changed, any of the following may be individually deployed:

$ ask deploy -t skill
$ ask deploy -t model
$ ask deploy -t lambda
  1. ./skill.json

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

    Remember that many details are language-specific and must be changed for each locale (en-GB, en-US, de-DE).

    See the Skill Manifest Documentation for more information.

  2. ./lambda/custom/index.js

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

  3. ./models/*.json

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

Additional Resources

Community

Tutorials & Guides

  • Voice Design Guide - A great resource for learning conversational and voice user interface design.
  • CodeAcademy: Learn Alexa - Learn how to build an Alexa Skill from within your browser with this beginner friendly tutorial on CodeAcademy!

Documentation

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%