Skip to content

Fully updated README.md file with missing information and clear follow ups and SETUP TUTORIAL VIDEO #503

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
chethansai wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Fully updated README.md file with missing information and clear follow ups and SETUP TUTORIAL VIDEO #503

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2418f9b
Fully Updated README.md file with missing information and clear follo…
ChethanSaiKrishna Mar 16, 2020
f3572b1
Fully Updated README.md file with missing information and clear follo…
ChethanSaiKrishna Mar 16, 2020
7a0f2a0
Setup Tutorial - Internet Archive Voice Apps Google Action added
ChethanSaiKrishna Mar 17, 2020
cc25dfe
Setup Tutorial - Internet Archive Voice Apps Google Action tutorial v…
ChethanSaiKrishna Mar 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 30 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,38 @@
# Internet Archive Google Action [![Build Status](https://travis-ci.org/internetarchive/internet-archive-voice-apps.svg?branch=master)](https://travis-ci.org/internetarchive/internet-archive-voice-apps) [![Coverage Status](https://coveralls.io/repos/github/internetarchive/internet-archive-google-action/badge.svg?branch=master)](https://coveralls.io/github/internetarchive/internet-archive-google-action?branch=master)

## Watch Setup Tutorial video
[Setup Tutorial - Internet Archive Voice Apps Google Action](https://youtu.be/YmNf6sWxT38)

## Setup Instructions
See the developer guide and release notes at https://developers.google.com/actions/ for more details.

### Steps for cloning project to your local machine
1. Fork repository.
2. Go to directory ::`git clone <repository link>`

### Steps for testing with Google Assistant
#### Create and setup project in Actions Console
1. Use the [Actions on Google](https://console.actions.google.com/) Console to add a new project with a name of your choosing and click Create Project.
2. Click `skip`
2. Click `skip` ["Actions Console" label on top left]
3. Go to actions under build, and click `Add your first action`
4. select custom intent, then `build`
#### Create Action for the project
1. Click `CREATE` (continued from above step)
2. Go to `settings` and click `export and import`, then click `restore from zip`.
3. zip the contents of `models/dialogflow/` and use that zip to restore the project.
3. zip the contents of `dialogflow` in `models/dialogflow/` and use that zip to restore the project.
#### Run Local Server
Run server local with colorful logs
1. `npm install -g firebase-tools`
2. `touch functions/.runtimeconfig.json` and add fake keys (temporary workaround) refer [this](https://github.com/internetarchive/internet-archive-voice-apps/issues/434#issuecomment-453114249)
0. Run server local with colorful logs
0. Install node js if not installed before(Check for correct version of node by `node -v`.if not `nvm install 8.16.0` and `nvm use 8.16.0`)
1. `npm install -g firebase-tools`
1. `firebase login`[On the opened tab in your browser,login with the same account you created project on google actions]
2. `touch functions/.runtimeconfig.json` (For windows cli clone touch repository to use it `git clone https://www.github.com/zacharyjbaldwin/touch-for-windows.git`)
2. `firebase init` (remove .firebaserc first)
3. `firebase use --add` (and choose your own firebase project)
3. `firebase projects:list`[displays projects list with your account]
3. `firebase use --add` (choose the project you created in actions console, give an alias name)
3. add fake keys (temporary workaround) refer [this](https://github.com/internetarchive/internet-archive-voice-apps/issues/434#issuecomment-453114249)
3.`firebase deploy --only functions`
4. `cd functions` and `npm install`
4. `DEBUG=ia:* npm start`
4. `DEBUG=ia:* npm start` (In windows `set debug=<project alias name>`then `npm start`)
#### Expose local server
To expose server to google assistant use [ngrok](https://ngrok.com/)
its free plan should be enough.
Expand All @@ -47,6 +59,17 @@ https://<id>.ngrok.io/<your project name>/us-central1/assistant
- profile performance of requests
Env Variable: `PROFILE_REQUESTS=true` (`false` by default)
`firebase functions:config:set performance.requests=true`
## How to check if the project is sucessfully synced

type welcome in google assistant test
It reponds <speak>Welcome to the music at the Internet Archive. Want to listen to 78s, Live concerts, Unlocked Recordings or Christmas music?</speak>

Now go to

internet-archive-voice-apps\functions\src\strings.js
Find the text: welcome change acknowledge >Welcome to music at the Internet Archive(removing the)
type welcome in google assistant test
You will find the changes reflected as:<speak>Welcome to music at the Internet Archive. Want to listen to 78s, Live concerts, Unlocked Recordings or Christmas music?</speak>

### How to make contributions?

Expand Down