{"id":25053702,"url":"https://github.com/artificialsolutions/teneo-web-chat","last_synced_at":"2025-10-21T10:30:21.489Z","repository":{"id":37924041,"uuid":"168038840","full_name":"artificialsolutions/teneo-web-chat","owner":"artificialsolutions","description":"Web-based chat UI for Teneo chatbots that can be embedded in websites.","archived":false,"fork":false,"pushed_at":"2024-05-22T10:12:28.000Z","size":5714,"stargazers_count":33,"open_issues_count":29,"forks_count":10,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-05-22T10:56:52.048Z","etag":null,"topics":["chat-widget","chatbot","javascript-api","teneo","teneo-api","teneo-engine","teneo-studio","vue","website"],"latest_commit_sha":null,"homepage":"https://developers.teneo.ai/resource/channels/teneo-web-chat","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/artificialsolutions.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-01-28T21:16:33.000Z","updated_at":"2024-06-12T16:57:27.495Z","dependencies_parsed_at":"2024-01-16T10:36:06.541Z","dependency_job_id":"b10400fe-8ecc-49e9-9431-6ce8c153b0f9","html_url":"https://github.com/artificialsolutions/teneo-web-chat","commit_stats":{"total_commits":738,"total_committers":16,"mean_commits":46.125,"dds":"0.39159891598915986","last_synced_commit":"42c72b378bdd8fd5bff1e5c02a6b4ba9f07ca3a8"},"previous_names":[],"tags_count":35,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artificialsolutions%2Fteneo-web-chat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artificialsolutions%2Fteneo-web-chat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artificialsolutions%2Fteneo-web-chat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artificialsolutions%2Fteneo-web-chat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/artificialsolutions","download_url":"https://codeload.github.com/artificialsolutions/teneo-web-chat/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237430708,"owners_count":19308946,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chat-widget","chatbot","javascript-api","teneo","teneo-api","teneo-engine","teneo-studio","vue","website"],"created_at":"2025-02-06T11:50:52.923Z","updated_at":"2025-10-21T10:30:15.979Z","avatar_url":"https://github.com/artificialsolutions.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Teneo Web Chat\n\n\u003e [!IMPORTANT]\n\u003e This project has been retired and archived  \n\u003e The project is based on [Vue2 which is now EOL](https://v2.vuejs.org/eol/) and to migrate to Vue 3 would require major rework.  \n\u003e  \n\u003e A commercial offering \"Teneo Web Widget\" is available from Teneo.ai now which is based on a more modern tech stack and will benefit from commercial support.\n\u003e You can find [Teneo Web Widget releases here](https://github.com/artificialsolutions/teneo-web-widget/releases)  \n\u003e If there is a need of continued use / development of this project for your own needs please feel free to fork the project - which will remain here in archived form.\n\n## Overview\n\nTeneo Web Chat is a chat widget that can be embedded in websites. Support for various components like buttons, quick replies, images, audio, videos and cards is built-in and the available Teneo Web Chat JavaScript API allows for easy live chat integration and extendability.\n\nCore features:\n\n+   Supports various message types, like cards, images, buttons, quick replies etc.\n+   Lightweight\n+   Easy to embed in websites\n+   Extendable through a powerful Javascript API\n+   Works on all major browsers like Chrome, Edge, Firefox, Internet Explorer 11, Opera and Safari\n+   Works on mobile devices\n+   Accessible (WCAG ready)\n+   Available in multiple languages, easy to localize\n+   Open source\n\nAdditional Features:\n\n+   [TTS/ASR](docs/features/TTS.md).\n+   [Rating Message](docs/features/Rating%20Message.md).\n+   [Upload files](docs/features/upload.md).\n\n+   This readme contains high-level information about running Teneo Web Chat. For full documentation, please refer to the [Teneo Web Chat Documentation](https://developers.teneo.ai/resource/channels/teneo-web-chat) on the Teneo Developers website.\n\n## Prerequisites\n\n+   Your bot needs to be published and you need to know the engine URL.\n+   To embed Teneo Web Chat in your site, you will need to be able to upload a javascript file and embed code into the website's html.\n\n## Setup options\n\n### Adding the web chat UI to your site\n\nTo add the web chat UI to your site, proceed as follows:\n\n#### Download teneo-web-chat.js\n\nDownload the file `teneo-web-chat.js` from the [latest release on Github](https://github.com/artificialsolutions/teneo-web-chat/releases/) and add it to your site.\n\n#### Update pages\n\nAdd the following code before the closing `\u003c/body\u003e` tag to _each page_ where you want the web chat window to appear.\n\n```html\n\u003c!-- Teneo Web Chat start --\u003e\n\u003cdiv id=\"teneo-web-chat\"\u003e\u003c/div\u003e\n\u003cscript src=\"/path/to/teneo-web-chat.js\"\u003e\u003c/script\u003e\n\u003cscript\u003e\n/* \u003c![CDATA[ */\n\nwindow.addEventListener('load', () =\u003e {\n    const element = document.getElementById('teneo-web-chat');\n    const teneoProps = {\n        teneoEngineUrl: 'https://some.teneo/engine-instance/',\n    }\n    window.TeneoWebChat.initialize(element,teneoProps);\n});\n\n/* ]]\u003e */\n\u003c/script\u003e\n\u003c!-- Teneo Web Chat end --\u003e\n```\n\nWhen adding the script to your site, note the following:\n\n+   Make sure `/path/to/teneo-web-chat.js` is replaced with the correct path.\n+   Make sure `https://some.teneo/engine-instance/` is updated to match the url of your engine.\n\n#### Initialization properties\n\nWhen initializing Teneo Web Chat, an object containing the configuration options can be passed on. In the [code](#update-pages) above, an object called `teneoProps` is used to pass on the configuration options. See the [Teneo Web Chat Documentation](https://developers.teneo.ai/resource/channels/teneo-web-chat) on the Teneo Developers website for all options.\n\n### Deploy to Heroku\n\n**Note: Starting November 28, 2022, free Heroku Dynos, free Heroku Postgres, and free Heroku Data for Redis® plans will no longer be available.**\n\nIf you are looking for a quick way to interact with your bot using Teneo Web Chat but you don't have a website to host it yet, you can deploy it to Heroku. Click the button below to create a new Heroku app that hosts the web chat:\n\n[![Deploy](https://www.herokucdn.com/deploy/button.svg?classes=heroku)](https://heroku.com/deploy?template=https://github.com/artificialsolutions/teneo-web-chat)\n\n1.  Give the app a name (lowercase, no spaces)\n2.  In the 'Config Vars' section, add the following:\n    +   **TENEO_ENGINE_URL:** The engine url.\n3.  Click 'Deploy app'.\n\nWhen Heroku has finished deploying, click 'View app'. You should now be able to use the web chat ui to talk to your bot.\n\n### Running the code locally\n\nIf you want to run the code locally, proceed as follows:\n\n1.  Clone the project:\n\n    ```git\n    git clone https://github.com/artificialsolutions/teneo-web-chat \u0026\u0026 cd teneo-web-chat\n    ```\n\n2.  Install dependencies:\n\n    ```node\n    npm install\n    ```\n\n    \u003e [!NOTE]\n    \u003e if you're using Windows and get an error \"'NODE_ENV' is not recognized as an internal or external command, operable program or batch file.\", you may want to install a module called [win-node-env](https://github.com/laggingreflex/win-node-env) and run `npm install` again.\n\n3.  Create a `.env` file in the `teneo-web-chat` folder with the following (replace the dummy url with Teneo Engine url of your bot):\n\n    ```env\n    TENEO_ENGINE_URL=https://some.engine/instance/\n    ```\n\n4.  Start the application:\n\n    ```node\n    npm run start:dev\n    ```\n\nThe page is now available on [http://localhost:9000](http://localhost:9000).\n\n#### Building teneo-web-chat.js\n\nIf you've made modifications to the code and you want to build the bundle, run:\n\n```node\nnpm run-script build\n```\n\nThis will add a file `teneo-web-chat.js` in the `/dist` folder of the project. You can use this `teneo-web-chat.js` to add to your site.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fartificialsolutions%2Fteneo-web-chat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fartificialsolutions%2Fteneo-web-chat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fartificialsolutions%2Fteneo-web-chat/lists"}