Skip to content
πŸ–₯ Web App for Dialogflow V2. 100/100 PWA. Actions on Google, Rich Components and more
Branch: master
Clone or download

README.md

Dialogflow for Web v2

What is Dialogflow, by the way?

Dialogflow lets you build conversational interfaces on top of your products and services by providing a powerful natural language understanding (NLU) engine to process and understand natural language input

This is a unofficial Web Integration for Dialogflow V2, built to support rich responses and make the most out of the Platform available to the Web

The development of this project was made possible by me. You can hire me or send me some snacks

If you have any questions, feel free to contact me

Features

  • Progressive Web App (100/100 Lighthouse score)
  • Accessibility Features
  • Wide Browser Support (IE8+), offline capabilities (history) and great SEO
  • Familiar UI & UX, based on the official Google Assistant Design Specifications
  • Hands-free interaction with Voice Input and Speech Feedback
  • Language Independency
  • Docker and Kubernetes support
  • Rich-component, Webhook and Actions on Google Support (demo)
  • Iframe Support (demo)
  • Based on Vue, Webpack 4, Babel 7
  • Lightweight (with ngx_pagespeed the build is <100KB)
  • Free and Documented (documentation coverage at least 80%)
  • Free hosted version on Dialogflow Gateway
  • Made in Germany (if it makes any sense to you)

Contributing

There are many ways you can contribute to the project:

  • Adding more translations
  • Fixing bugs and contributing to the code base
  • Leaving your feedback and suggesting more features
  • Donating
  • Sharing

Getting started

Requirements

  • NodeJS
  • NPM or Yarn
  • Basic knowledge in ES6 (JavaScript)
  • Google Account and Dialogflow V2 Agent (if you look for V1, please use my old repo and the instructions)

Setting Up Dialogflow Gateway

Dialogflow Gateway is a cloud-based service, which makes third-party Dialogflow V2 Integrations, like this one possible.

Follow a detailed guide, on how to connect your Agent to the Gateway here and return to this guide, when you are finished

Cloning the repository to your machine

You can use git or download it directly from github

Getting the dependencies

Open your cloned folder. Then, using your favorite package manager get the dependencies

Example using npm

npm install

Example using yarn

yarn

Customizing App & Connecting your Agent

Open config.js and change the gateway variable to your Dialogflow Gateway URL. If you don't know, what Dialogflow Gateway is, please read the docs one more time, because you have missed something out.

Hint: the Dialogflow Gateway URL is always your google cloud project name + .gateway.dialogflow.cloud.ushakov.co. When you have troubles finding it, make sure you have connected your Agent to the Gateway, then visit the console, click on "Manage" and copy the Gateway URL

Example

export default {
    app: {
        gateway: "https://dialogflow-web-v2.gateway.dialogflow.cloud.ushakov.co"
        [...]
    }
}

[...]

The logo, agent name, description and the available languages are fetched from Dialogflow directly. If you want to change them, then you should do it in the Dialogflow Console and it will be synced to the UI. Please note, when adding new languages, you need to translate some of the UI as well (i18n field in config.js). Also don't forget to clean your cache, if you make some changes to the Agent

Start development server & build

Open your cloned folder. Then, using your favorite package manager run dev command

Example using npm

npm run dev

Example using yarn

yarn dev

When you done these steps, your default browser should open and redirect you to localhost:8080. If the port 8080 is already in use, you can give an port argument to connect at specified port

Example using npm

npm run dev --port 9090

Example using yarn

yarn dev --port 9090

PLEASE DO NOT USE THE DEVELOPMENT SERVER FOR SERVING YOUR APP IN PRODUCTION, DEVELOPMENT SERVER IS MEANT FOR THE DEVELOPMENT. INSTEAD PLEASE UPLOAD BUILD ARTIFACTS TO A STATIC WEB-SERVER

Building for production

Your app will be bundled to dist/build.js

To build it you can use npm or yarn

Example using npm

npm run build

Example using yarn

yarn build

Frequently Asked Questions

  • Q: I changed the gateway url, but the responses are the same as with the previous one
  • A: Make sure you have cleaned your cache and rebuilt your app. In Safari go to "Develop" > "Empty Caches". In Chrome: "Developer Tools" > "Application" > "Clear storage" > "Clear site data"

Have fun using the product!

You can’t perform that action at this time.