pdhoward / richvue

Experimental App - Emulating RCS in Vue

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Cogntiive Interaction (mocked)

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
  • Dark Mode & Theming
  • 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 (build is <100KB)
  • Free and Documented
  • Made in Germany
  • Recommended by Dialogflow and MadeWithVueJS:

Installation

Requirements

  • NodeJS
  • NPM or Yarn
  • Basic knowledge in JS

Read the license

Set up Gateway (backend)

Dialogflow Gateway enables third-party integrations like this one to securely access the Dialogflow V2 API

Clone the repository

Get the dependencies

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

Using npm

npm install

Using yarn

yarn

Connect 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 URL for Dialogflow Gateway Hosted by Ushakov is always your google cloud project id + .gateway.dialogflow.cloud.ushakov.co. If you have troubles, make sure you 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. Change them in Dialogflow and it will be synced to the UI. Please note, when adding new languages, you may have to translate some of the UI as well (i18n field in config.js). Also don't forget to clean your cache, if you make changes to the Agent

Developing

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

Using npm

npm run dev

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

Using npm

npm run dev --port 9090

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

Theming

You can make a custom theme for Dialogflow for Web v2, according to the specification:

To apply the variables, open src/components/App/Theme.sass and change them in the \:root selector

You can also optimize your theme for Dark-mode-enabled clients within the same file and selector under the @media (prefers-color-scheme: dark)

Building

Your app will be bundled to dist/build.js

To build it you can use npm or yarn

Using npm

npm run build

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"

About

Experimental App - Emulating RCS in Vue

License:MIT License


Languages

Language:Vue 76.3%Language:JavaScript 11.6%Language:CSS 7.7%Language:HTML 4.2%Language:Dockerfile 0.1%