Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jolzee/leopard-chat-ui-teneo
Leopard Chat UI - A Teneo Chat Client based on Vue and Vuetify
https://github.com/jolzee/leopard-chat-ui-teneo
asr bot cai chat-teneo-vue chatbot leopard nli nlp teneo tts virtual-assistant vue vuejs vuetify vuetifyjs
Last synced: 2 months ago
JSON representation
Leopard Chat UI - A Teneo Chat Client based on Vue and Vuetify
- Host: GitHub
- URL: https://github.com/jolzee/leopard-chat-ui-teneo
- Owner: jolzee
- License: apache-2.0
- Created: 2018-07-10T15:43:17.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T00:39:54.000Z (almost 2 years ago)
- Last Synced: 2023-03-07T13:55:06.718Z (almost 2 years ago)
- Topics: asr, bot, cai, chat-teneo-vue, chatbot, leopard, nli, nlp, teneo, tts, virtual-assistant, vue, vuejs, vuetify, vuetifyjs
- Language: Vue
- Homepage: https://www.teneo.ai/
- Size: 54.1 MB
- Stars: 67
- Watchers: 5
- Forks: 26
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
A Feature Rich Chat Client for Teneo
About •
Installation •
Features •
Documentation •
Demo •
Contributing •
Author •
Support •
License
---
## About
**Leopard Chat UI** is a **feature rich** chat client for Teneo. Teneo is capable of returning rich data along with each response and Leopard leverages these responses to present an interactive chat experience.
Leopard can be used in both production and in a Sales Engineering mode. The Sales Engineering mode allows for numerous conversational demonstrations to be easily configured, deep linked to or shared.
An administration interface is provided where you can tweak the look and feel of the chat UI per conversational solution.
### Built with
- [Vue.js](https://vuejs.org/)
- [Vuetify](https://vuetifyjs.com/en/)
## Installation
##### Windows Users
If you're developing on windows you will most likely have to install `node-gyp` before you attempt to run `npm install`. You will need to compile some native node modules. To enable this on Windows you can run this one liner. It's going to take a while to complete but it only has to be run once. Start **PowerShell as Administrator** and run:
```sh
npm install --global windows-build-tools
```
#### Downloading and installing steps:
```sh
git clone https://github.com/jolzee/leopard-chat-ui-teneo
cd leopard-chat-ui-teneo
npm install
```
#### Configuration
Leopard is configured using `/config/default.js` which is a **commented** JavaScript module. You can either directly add your configuration to default.js or to an adjacent `local.js` which takes precedence and is added to .gitignore. The conversational solutions are configured through the [`.env.solution.json`](https://jolzee.gitbook.io/leopard/configuration/leopard-config-page#default-configuration) file in the root of the project. If you want to make some changes prior to running/building Leopard then do so now.
#### Run Locally in Development Mode
```sh
npm run serve
```
#### Build for production
The build process runs the source code through Webpack and produces the final build into the `/dist` folder.
```sh
npm run build
```
#### Deployment
Copy all the files within `/dist` to any web server - For example `https://mydomain.com/leopard/`.
The Chat UI can then be used in Sales Engineering mode by visiting `https://mydomain.com/leopard/`
#### Embed in Production
You can inject Leopard Chat UI into a specific element on a page. This might be beneficial if you want to place it in a specific tab order. To enable this add a `
` anywhere on the page. This is not required though and if absent the UI will automatically be injected at the beginning of the body.
```html
window.TENEOCTX || (TENEOCTX = {});
TENEOCTX = {
init: {
trustedDomain: "", // something like http://localhost:8080 // "" = receive and post messages to all domains
allowScripts: true // false = if you want to disable potential eval
},
ctx: {
eventSource: "leopard-embed",
pageTitle: document.title,
pageUrl: window.location.href,
pageTopic: "Help",
message: "This was sent from the customer's web site"
}
};
```
## Features
| | Supported |
| ----------------------------------------------------------------------------------------------------------------- | :-------: |
| [ASR & TTS](https://jolzee.gitbook.io/leopard/configuration/asr-and-tts) | ✔️ |
| [Alerts](https://jolzee.gitbook.io/leopard/components/alerts) | ✔️ |
| [All modern browsers & IE 11](https://jolzee.gitbook.io/leopard/#browser-compatibility) | ✔️ |
| [Answer Text Formatting](https://jolzee.gitbook.io/leopard/components/answer-text-formatting) - HTML and Markdown | ✔️ |
| [Audio Player](https://jolzee.gitbook.io/leopard/components/audio) | ✔️ |
| [Auto Switch Solutions](https://jolzee.gitbook.io/leopard/components/language-auto-switch) | ✔️ |
| [Buttons](https://jolzee.gitbook.io/leopard/components/buttons-and-lists) | ✔️ |
| [Cards](https://jolzee.gitbook.io/leopard/components/card) | ✔️ |
| [Custom Forms](https://jolzee.gitbook.io/leopard/components/forms-1/forms) | ✔️ |
| [Custom HTML Modals](https://jolzee.gitbook.io/leopard/components/custom) | ✔️ |
| [Custom Response Icons](https://jolzee.gitbook.io/leopard/components/custom-response-icons) | ✔️ |
| [Dark Mode](http://lychee.joles.xyz/#15895788995003/15895789274934) | ✔️ |
| [Date and Time Pickers](https://jolzee.gitbook.io/leopard/components/date-and-time-pickers) | ✔️ |
| [Deep Link to Question](https://jolzee.gitbook.io/leopard/components/deep-linked-question) | ✔️ |
| [Dynamic Theme Changes](https://jolzee.gitbook.io/leopard/components/dynamic-theme-change) | ✔️ |
| [Emergency Button](https://jolzee.gitbook.io/leopard/components/emergency-button) | ✔️ |
| [Expensive Operations](https://jolzee.gitbook.io/leopard/components/expensive-operations) | ✔️ |
| [Extension Helper (Groovy)](https://jolzee.gitbook.io/leopard/installation/extension-helper) | ✔️ |
| [Feedback Forms](https://jolzee.gitbook.io/leopard/components/forms-1/feedback-form) | ✔️ |
| [Field Masks](https://jolzee.gitbook.io/leopard/components/field-masks) | ✔️ |
| [Field Types](https://jolzee.gitbook.io/leopard/components/field-types) - [email / password / location / upload] | ✔️ |
| [Firebase Social Authentication](https://jolzee.gitbook.io/leopard/integrations/social-authentication) | ✔️ |
| [Geo Context Capture](https://jolzee.gitbook.io/leopard/installation/context-variables/context-parameters) | ✔️ |
| [Hyperlinks that send input back to Teneo](https://jolzee.gitbook.io/leopard/components/hyperlinks) | ✔️ |
| [Image Carousels](https://jolzee.gitbook.io/leopard/components/images/image-carousel) | ✔️ |
| [Images](https://jolzee.gitbook.io/leopard/components/images/image) | ✔️ |
| [Input Field Help Text](https://jolzee.gitbook.io/leopard/components/input-field-help-text) | ✔️ |
| [LiveChatInc.com](https://jolzee.gitbook.io/leopard/integrations/live-chat) | ✔️ |
| [Maps](https://jolzee.gitbook.io/leopard/components/maps) | ✔️ |
| [Proactive Dialogs](https://jolzee.gitbook.io/leopard/components/prompt-trigger-polling) | ✔️ |
| [Sentry and LogRocket](https://jolzee.gitbook.io/leopard/integrations/logging-reporting) - Logging and Reporting | ✔️ |
| [Split Answers](https://jolzee.gitbook.io/leopard/components/splitting-a-response) | ✔️ |
| [Tables](https://jolzee.gitbook.io/leopard/components/tables) | ✔️ |
| Themeable | ✔️ |
| [Toasts](https://jolzee.gitbook.io/leopard/components/toasts) | ✔️ |
| [Video Player](https://jolzee.gitbook.io/leopard/components/video) (YouTube, Vimeo, mp4) | ✔️ |
| [i18n](https://jolzee.gitbook.io/leopard/configuration/asr-and-tts) | ✔️ |
## Screenshots
## Documentation
Do you **need some help**? Check the [_complete documentation_](https://jolzee.gitbook.io/leopard/).
## Contributing
Got **something interesting** you'd like to **share**? Learn about [contributing](https://github.com/jolzee/leopard-chat-ui-teneo/blob/master/.github/CONTRIBUTING.md).
## Author
| [](https://www.linkedin.com/in/peterjoles/) |
| :--------------------------------------------------------------------------------------------------------------: |
| **Peter Joles** |
## Support
Reach out to me at one of the following places:
- [peter.joles.xyz](http://peter.joles.xyz/)
- **[email protected]**
## License
Distributed under the Apache License 2.0. See [**LICENSE**](https://github.com/jolzee/leopard-chat-ui-teneo/blob/master/LICENSE) for more information.
## Attributions
Icons made by Pixel perfect from www.flaticon.com