Goodtok NPM | npm.io

GoodTok

GitHub

GoodTok helps businesses enhance their customer service right from their website. The video application lets customers connect with your staff in real-time. You can integrate this simple and easy-to-use application into any website.

This project is just starting and is not ready for production use yet 🚧

Architecture

Coming soon.

Give a star! ⭐

I would mean a lot to me if you could give this project a star. It helps me identify if I'm doing a good job or not. Also, it helps me attract potential contributors and users. 🙏

Installation

I'm aiming to make this as easy as possible to install. I'm working on a docker image allowing you to run this application with a single command. When it is ready, you will be able to run the following command to get started:

docker compose up -d

The previous command will start the front-office application. You will then be able to access the application at http://localhost:3000 and start sending requests from the client application.

In the website where you want to integrate GoodTok, you will need to add the following script tag:

<!-- GoodTok video client -->
<script
  id="goodtok-script"
  type="text/javascript"
  src="https://goodtok.com/client/web.js?key=1413d7-031-13bWa28"
>
</script>
<!-- GoodTok video client end -->

Usage

I'm still refining the usage of this application. But the core flow will be as follows:

A customer visits your website and clicks on the GoodTok widget
The customer is prompted to enter their name and email address
If the customer is "logged in," they get to skip the previous step
The user gets placed in a queue and waits for an agent to become available
When an agent becomes available, the customer is notified, and the video chat starts