2.0.0 • Published 6 years ago

@genie-ai/genie-router-plugin-web-client v2.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
6 years ago

genie-router-plugin-web-client

This plugin offers a web interface to chat with genie-router. It will register itself at /web-client/. Optionally, by configuring registerOnRoot to true, it will also listen on /.

This plugin requires that the http-api plugin is installed.

Installation

At the plugin location ($HOME/.genie-router), type:

npm install --save @genie-ai/genie-router-plugin-web-client

Then add web-client: {}, to the plugins section of the genie-router configuration. Optionally add additional configuration items.

Configuration

There are several config items, each of which are optional:

  1. endpoint, the HTTP path on genie-router on which genie-router-plugin api-http listens, defaults to /api/message
  2. accessToken, if configured, the accessToken, if configured for invoking the HTTP endpoint
  3. registerOnRoot, If the web-client endpoint must also be registered at /
  4. prefix, if genie-router is configured on a subdirectory of a domain this must be the prefix to access it. The prefix will be appended before /web-client/

Room for improvement

  • When/if genie-router supports it, get the http-api plugin configuration via an internal API.
  • Add voice input if supported in the webbrowser

Credits

Uses the unnamed CSS framework Textballoon via here.