Internet Archive Google Action

Setup Instructions

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

Steps for testing with Google Assistant

Create and setup project in Actions Console

1. Use the Actions on Google Console to add a new project with a name of your choosing and click Create Project.
2. Click skip
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.

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
3. firebase init (remove .firebaserc first)
4. firebase use --add (and choose your own firebase project)
5. cd functions and npm install
6. DEBUG=ia:* npm start

Expose local server

To expose server to google assistant use ngrok its free plan should be enough.

To publish 5000 port use:

ngrok http 5000

you should find url https://<id>.ngrok.io/.

Connect webhook to dialogflow

Go to the fullfillment section of your dialogflow draft copy of our app and after that you should use this url:

https://<id>.ngrok.io/<your project name>/us-central1/assistant

Setup Env

Options

• profile performance of requests Env Variable: PROFILE_REQUESTS=true (false by default) firebase functions:config:set performance.requests=true

How to make contributions?

🔍 get one good first issue assign yourself (if you have access) or write comment that you'd like to work on this issue. That's help to prevent work overlapping.

create git branch feature/<name-of-feature>, more

💻 working on it

Use Mocha for continuous checking of your code quality and cover functionality by tests

npm run mocha -- --watch

☕ Complete checking of code by run unit tests and code style checking

npm test

🌟 We follow standard javascript code style.

Automatic style fixing, it doesn't solve all problems but could be very helpful

npm run lint -- --fix

🎉 Finally make Pull Request and give complete description what have you done and link the addressed issue.

Also it could be good practice to create your Pull Request earlier, but add WIP: at the beginning of its name! This way other developers could see what are you working right now.