Skip to content

Latest commit

 

History

History
89 lines (76 loc) · 3.41 KB

README.md

File metadata and controls

89 lines (76 loc) · 3.41 KB
Raw

Alexa Skill example (HelloWorld - TypeScript)

This repository is a template project of Alexa Skill for ASK CLI(v2)'s "ask new" command. We can easy to setup own Alexa custom skill with TypeScript and AWS CloudFormation.

Usage

% ask new  --template-url https://github.com/talkyjs/talkyjs-alexa-skill-template-helloworld.git

? Choose a method to host your skill's backend resources:  (Use arrow keys)
❯ Alexa-hosted skills
  Host your skill code by Alexa (free). 
  AWS with CloudFormation
  Host your skill code with AWS services and provision with AWS CloudFormation (requires AWS account) 
  AWS Lambda
  Host your skill code on AWS Lambda (requires AWS account). 
  ──────────────
  self-hosted and manage your own hosting 
  
[Warn]: CLI is about to download the skill template from unofficial template https://github.com//talkyjs/talkyjs-alexa-skill-template-helloworld.git. Please make sure you understand the source code to best protect yourself
 from malicious usage.
? Would you like to continue download the skill template?  Yes
? Please type in your skill name:  talkyjs-alexa-skill-template-helloworld
? Please type in your folder name for the skill project (alphanumeric):  talkyjs-alexa-skill-template-helloworld

% tree talkyjs-alexa-skill-template-helloworld -I node_modules
.
├── LICENSE.txt
├── README.md
├── ask-resources.json
├── hooks
│   └── build.sh
├── infrastructure
│   └── lambda-deployer
├── lambda
│   ├── README.md
│   ├── package-lock.json
│   ├── package.json
│   ├── src
│   │   ├── HelpIntent
│   │   │   ├── HelpIntent.router.ts
│   │   │   ├── HelpIntent.speech.tsx
│   │   │   └── tests
│   │   │       ├── HelpIntent.router.spec.ts
│   │   │       └── HelpIntent.speech.spec.tsx
│   │   ├── LaunchRequest
│   │   │   ├── LaunchRequest.router.ts
│   │   │   ├── LaunchRequest.speech.tsx
│   │   │   └── tests
│   │   │       ├── LaunchRequest.router.spec.ts
│   │   │       └── LaunchRequest.speech.spec.tsx
│   │   ├── StopAndCancelAndNoIntent
│   │   │   ├── StopAndCancelAndNoIntent.router.ts
│   │   │   ├── StopAndCancelAndNoIntent.speech.tsx
│   │   │   └── tests
│   │   │       ├── StopAndCancelAndNoIntent.router.spec.ts
│   │   │       └── StopAndCancelAndNoIntent.speech.spec.tsx
│   │   ├── index.ts
│   │   └── tests
│   │       └── index.spec.ts
│   ├── tsconfig.json
│   └── webpack.config.ts
└── skill-package
    ├── assets
    │   ├── en-US_largeIcon.png
    │   └── en-US_smallIcon.png
    ├── interactionModels
    │   └── custom
    │       └── en-US.json
    └── skill.json

16 directories, 27 files

[Optional] Manually setup

$ rm -rf lambda/*
$ npx @talkyjs/cli new  --path lambda --database=dynamodb --controller=handler --ssml=default --no-test

Deployment

Nevermind! The project already supported the npm run build command by TypeScript with Webpack. So we just run ask deploy to build your project and deploy to AWS.