| 1 | Core SDK package contains basic components and default implementations of ASK SDK v2 for Node.js.
|
| 2 |
|
| 3 | ## What is ASK SDK v2 for Node.js
|
| 4 |
|
| 5 | The ASK SDK v2 for Node.js is an open-source Alexa Skill Development Kit. ASK SDK v2 for Node.js makes it easier for you to build highly engaging skills, by allowing you to spend more time on implementing features and less on writing boiler-plate code.
|
| 6 |
|
| 7 | ## Installing
|
| 8 | To use the Core SDK package, you need to install two modules: core SDK and model(peer dependency of core SDK) within your NPM project. Run the following commands in the terminal to install them:
|
| 9 |
|
| 10 | ```
|
| 11 | npm install --save ask-sdk-core
|
| 12 | ```
|
| 13 |
|
| 14 | ```
|
| 15 | npm install --save ask-sdk-model
|
| 16 | ```
|
| 17 |
|
| 18 | ## Usage and Getting Started
|
| 19 |
|
| 20 | You can find a getting started guide [here](https://github.com/alexa/alexa-skills-kit-sdk-for-nodejs/wiki).
|
| 21 |
|
| 22 | ## Usage with TypeScript
|
| 23 | The Core SDK package for Node.js bundles TypeScript definition files for use in TypeScript projects and to support tools that can read .d.ts files. Our goal is to keep these TypeScript definition files updated with each release for any public api.
|
| 24 |
|
| 25 | ### Pre-requisites
|
| 26 | Before you can begin using these TypeScript definitions with your project, you need to make sure your project meets a few of these requirements:
|
| 27 | - Use TypeScript v2.x
|
| 28 | - Includes the TypeScript definitions for node. You can use npm to install this by typing the following into a terminal window:
|
| 29 |
|
| 30 | ```
|
| 31 | npm install --save-dev @types/node
|
| 32 | ```
|
| 33 |
|
| 34 | ### In Node.js
|
| 35 | To use the TypeScript definition files within a Node.js project, simply import ask-sdk-core as below:
|
| 36 |
|
| 37 | In a TypeScript file:
|
| 38 |
|
| 39 | ```typescript
|
| 40 | import * as Alexa from 'ask-sdk-core';
|
| 41 | ```
|
| 42 |
|
| 43 | In a JavaScript file:
|
| 44 |
|
| 45 | ```javascript
|
| 46 | const Alexa = require('ask-sdk-core');
|
| 47 | ```
|
| 48 |
|
| 49 | ## Opening Issues
|
| 50 | For bug reports, feature requests and questions, we would like to hear about it. Search the [existing issues](https://github.com/alexa/alexa-skills-kit-sdk-for-nodejs/issues) and try to make sure your problem doesn’t already exist before opening a new issue. It’s helpful if you include the version of the SDK, Node.js or browser environment and OS you’re using. Please include a stack trace and reduced repro case when appropriate, too.
|
| 51 |
|
| 52 | ## License
|
| 53 | This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
|