Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amazon-archives/skill-sample-nodejs-calendar-reader
An Alexa Skill Sample showing how to import calendar data from an .ICS file.
https://github.com/amazon-archives/skill-sample-nodejs-calendar-reader
Last synced: about 2 months ago
JSON representation
An Alexa Skill Sample showing how to import calendar data from an .ICS file.
- Host: GitHub
- URL: https://github.com/amazon-archives/skill-sample-nodejs-calendar-reader
- Owner: amazon-archives
- License: other
- Archived: true
- Created: 2016-10-17T19:10:02.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-10-19T05:18:46.000Z (about 6 years ago)
- Last Synced: 2024-05-19T04:53:41.946Z (8 months ago)
- Language: JavaScript
- Size: 4.33 MB
- Stars: 75
- Watchers: 30
- Forks: 89
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Build An Alexa Calendar Reader Skill
[](https://github.com/alexa/skill-sample-nodejs-calendar-reader/blob/master/instructions/1-voice-user-interface.md)[](https://github.com/alexa/skill-sample-nodejs-calendar-reader/blob/master/instructions/2-lambda-function.md)[](https://github.com/alexa/skill-sample-nodejs-calendar-reader/blob/master/instructions/3-connect-vui-to-code.md)[](https://github.com/alexa/skill-sample-nodejs-calendar-reader/blob/master/instructions/4-testing.md)[](https://github.com/alexa/skill-sample-nodejs-calendar-reader/blob/master/instructions/5-customization.md)[](https://github.com/alexa/skill-sample-nodejs-calendar-reader/blob/master/instructions/6-publication.md)
This Alexa sample skill is a template for a basic calendar reader skill. Provided a calendar is plugged in, Alexa will provide details of upcoming events and scheduled activities.
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](#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](https://aws.amazon.com/), and the [ASK Developer Portal](https://developer.amazon.com/alexa-skills-kit). If not, [click here](./instructions/0-intro.md) for a more detailed walkthrough.
### Usage
```text
Alexa, ask events calendar how many events I have today.
>> "Sorry there aren't any events scheduled. Would you like to search again?
Alexa, open events calendar
```
### Repository Contents
* `/.ask` - [ASK CLI (Command Line Interface) Configuration](https://developer.amazon.com/docs/smapi/ask-cli-intro.html)
* `/lambda/custom` - Back-End Logic for the Alexa Skill hosted on [AWS Lambda](https://aws.amazon.com/lambda/)
* `/models` - Voice User Interface and Language Specific Interaction Models
* `/instructions` - Step-by-Step Instructions for Getting Started
* `skill.json` - [Skill Manifest](https://developer.amazon.com/docs/smapi/skill-manifest.html)
## Setup w/ ASK CLI
### Pre-requisites
* Node.js (> v4.3)
* Register for an [AWS Account](https://aws.amazon.com/)
* Register for an [Amazon Developer Account](https://developer.amazon.com/)
* Install and Setup [ASK CLI](https://developer.amazon.com/docs/smapi/quick-start-alexa-skills-kit-command-line-interface.html)
### Installation
1. Clone the repository.
```bash
$ git clone https://github.com/alexa/skill-sample-nodejs-calendar-reader/
```
2. Initiatialize the [ASK CLI](https://developer.amazon.com/docs/smapi/quick-start-alexa-skills-kit-command-line-interface.html) by Navigating into the repository and running npm command: `ask init`. Follow the prompts.
```bash
$ cd skill-sample-nodejs-calendar-reader
$ ask init
```
3. Install npm dependencies by navigating into the `/lambda/custom` directory and running the npm command: `npm install`
```bash
$ cd lambda/custom
$ 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. Deploy the skill and the lambda function in one step by running the following command:
```bash
$ ask deploy
```
### 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:
```bash
$ ask simulate -l en-US -t "start events calendar"
✓ 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](https://echosim.io/welcome), or through your Amazon Mobile App and say :
```text
Alexa, start events calendar
```
## Customization
1. ```./skill.json```
Change the skill name, example phrase, icons, testing instructions etc ...
Remember that many information is locale-specific and must be changed for each locale (en-GB and en-US)
See the Skill [Manifest Documentation](https://developer.amazon.com/docs/smapi/skill-manifest.html) 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 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.
## Additional Resources
### Community
* [Amazon Developer Forums](https://forums.developer.amazon.com/spaces/165/index.html) - Join the conversation!
* [Hackster.io](https://www.hackster.io/amazon-alexa) - See what others are building with Alexa.
### Tutorials & Guides
* [Voice Design Guide](https://developer.amazon.com/designing-for-voice/) - A great resource for learning conversational and voice user interface design.
* [CodeAcademy: Learn Alexa](https://www.codecademy.com/learn/learn-alexa) - Learn how to build an Alexa Skill from within your browser with this beginner friendly tutorial on CodeAcademy!
### Documentation
* [Official Alexa Skills Kit Node.js SDK](https://www.npmjs.com/package/alexa-sdk) - The Official Node.js SDK Documentation
* [Official Alexa Skills Kit Documentation](https://developer.amazon.com/docs/ask-overviews/build-skills-with-the-alexa-skills-kit.html) - Official Alexa Skills Kit Documentation
