https://github.com/finishy1995/voixa
Voixa project. Amazon Alexa Demo
https://github.com/finishy1995/voixa
alexa alexa-skill amazon-alexa-demo cloudformation-template cognito cralwer lambda serverless
Last synced: about 2 months ago
JSON representation
Voixa project. Amazon Alexa Demo
- Host: GitHub
- URL: https://github.com/finishy1995/voixa
- Owner: finishy1995
- Created: 2017-08-31T07:28:37.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-09-29T06:15:57.000Z (about 8 years ago)
- Last Synced: 2025-06-13T14:14:26.768Z (4 months ago)
- Topics: alexa, alexa-skill, amazon-alexa-demo, cloudformation-template, cognito, cralwer, lambda, serverless
- Language: Shell
- Size: 7.78 MB
- Stars: 4
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: readme-cn.md
Awesome Lists containing this project
README
# Voixa [Amazon Alexa Demo]
## 目录
- [简介](#简介)
- [特别感谢](#特别感谢)
- [项目架构](#项目架构)
- [版本信息](#版本信息)
- [v0.8](#v0.8)
- [v0.9](#v0.9)
- [更新计划](#更新计划)
- [项目部署](#项目部署)
## [简介](id:简介)
**特别提醒: 本如果有任何疑问和建议，请联系邮箱：*[david.wang@finishy.cn](mailto:david.wang@finishy.cn)*。**
Voixa是一个Amazon Alexa的示例项目。在本示例项目中，考虑到资讯爆炸的情况，我们想要利用Alexa自动播报真正感兴趣的话题。利用Serverless无服务器架构，实现了订阅指定网站的指定关键词（例：网站 AWS，关键词 大数据），利用Alexa自动播报相关资讯的简讯。
本演示仅用于试验和参考用途，如果您想在云端开发自己的应用，请登录AWS官网查看详细信息。 [English](https://github.com/finishy1995/voixa)
## [特别感谢](id:特别感谢)
**Big Five Wolves**
1. ***@Bob Zhang***
2. ***@Nick Jiang***
3. ***@Haipeng Qi***
4. ***@Andrew Ren***
5. ***@David Wang***
**@Jason Xue**
## [项目架构](id:项目架构)
采用如下架构搭建数据采集架构：
采用如下架构实现Alexa播报新闻：
## [版本信息](id:版本信息)
### [v0.8](id:v0.8)
包测试版本，这些版本功能有残缺或者存在一定的Bug，慎用。
- v0.8.1
- Demo 源代码
- Demo 架构
- 基本 AWS CloudFormation
- v0.8.2
- 修复已知 Bug
- 完善 AWS CloudFormation
- 基本安装脚本
- v0.8.3
- 修复前端 Bug
- 静态页面上传
- Cognito 自动配置
### [v0.9](id:v0.9)
内部测试版本，这些版本功能满足最低搭建要求，不保证所有操作系统和安装条件通过。
- v0.9.1
- 安装脚本自动化
- 修复 AWS CloudFormation 权限不足的 Bug
- 重写 Readme
-v0.9.2
- 修复 S3 文件名包含 “,” 的 bug
- 限制可选择的 region 为 [us-east-1, eu-west-1]
- 修复 S3 调用 API 创建存储桶可能造成的 bug
## [更新计划](id:更新计划)
- [x] 编写启动脚本，结合 AWS CloudFormation 自动部署
- [x] Readme 详细部署步骤
- [x] 加入 Cognito 提高安全性
- [x] 添加项目架构图
- [x] Readme 中英文
- [ ] 支持更多的操作系统运行脚本
- [ ] 添加更多的网站和内容组合
- [ ] 完善静态网站功能和页面效果
- [ ] 添加App，支持 Android & IOS
## [项目部署](id:项目部署)
**提醒: 以下步骤在具备 aws-cli 和 Mac 系统下测试通过，其他情况下如有问题，请提交问题，谢谢！**
### 前提条件
您需要具有 AWS 全球区账号，并具备 Admin 权限 （事实上并不需要这么大的权限，后续会降低权限要求）。
### 安装 aws-cli
如果您已经安装好了 aws-cli，可以跳过此步骤
```sh
sudo pip install awscli
```
更多的安装方法，请参考 [aws-cli链接](https://github.com/aws/aws-cli)
### 配置 aws-cli
如果您已经配置好了 aws-cli，可以跳过此步骤
```sh
aws configure --profile ${your_profile_name}
```
配置遇到了问题？请参考 [aws-cli链接](https://github.com/aws/aws-cli)
### 安装 Voixa
```sh
wget --no-check-certificate https://raw.githubusercontent.com/finishy1995/voixa/master/install.sh && chmod u+x install.sh && ./install.sh
```
### 配置 Alexa
在 [Amazon Developer 网站](https://developer.amazon.com/) 上配置自己的 Alexa Skill。您可以参考如下配置信息。
**Skill Information**
**Interaction Model**
- Intent Schema
```Json
{
"intents": [
{
"intent": "AMAZON.ResumeIntent"
},
{
"intent": "AMAZON.PauseIntent"
},
{
"slots": [
{
"name": "blog",
"type": "LIST_OF_BLOG"
}
],
"intent": "MyBlogIsIntent"
},
{
"intent": "WhatsMyBlogIntent"
},
{
"intent": "AMAZON.HelpIntent"
}
]
}
```
- Sample Utterances
```
MyBlogIsIntent my favorite blog is {blog}
WhatsMyBlogIntent what's my favorite blog
WhatsMyBlogIntent what is my favorite blog
WhatsMyBlogIntent what's my blog
WhatsMyBlogIntent what is my blog
WhatsMyBlogIntent my blog
WhatsMyBlogIntent my favorite blog
WhatsMyBlogIntent get my blog
WhatsMyBlogIntent get my favorite blog
WhatsMyBlogIntent give me my favorite blog
WhatsMyBlogIntent give me my blog
WhatsMyBlogIntent what my blog is
WhatsMyBlogIntent what my favorite blog is
WhatsMyBlogIntent yes
WhatsMyBlogIntent yup
WhatsMyBlogIntent sure
WhatsMyBlogIntent yes pleaseBlog
```
**Configuration**
Lambda Arn 可以在 AWS CloudFormation 的 Outputs 中获取。
**Test**
"Service Simulator" 在本项目中不应该被填入。
**Publishing Information**
**Privacy & Compliance**
### 自定义网站订阅
打开 AWS CloudFormation 的 Outputs 中提供的静态网址，配置自己的订阅信息。
### Alexa Simulator
您可以用 Echo／Echo dot 测试这个项目，也可以使用模拟网站 [echosim](https://echosim.io/welcome)