Omnichannel Environment Setup

This documentation will guide you through setting up your Rocket.Chat omnichannel development environment.

Prerequisites

Ensure you have the following installed on your device.

• Git

• Node.js

• Yarn is recommended instead of npm.

Set up Livechat

This Livechat platform is a minimal lightweight application developed with Preact. It is a critical feature of the Rocket.Chat omnichannel as it facilitates B2C (business-to-customer) communication between agents and website visitors.

This setup is done assuming you have a Rocket.Chat server running. We will use a local instance at http://localhost:3000 for this guide.

To set up the omnichannel Livechat,

1. Clone the Livechat source code from the GitHub repository by running this command:

   git clone https://github.com/RocketChat/Rocket.Chat.git

2. Navigate to the Livechat folder in the cloned directory.

   cd Rocket.Chat
   cd packages/livechat

3. Install dependencies by running:

   yarn

   You can check the recommended version of node and yarn in the package.json file in the root directory.

4. Compile the Preact application to the /build folder by running:

   yarn dev

5. In another terminal, start the development server with hot reload capabilities on http://localhost:8080:

   yarn start

6. Open the widget-demo.html file in your browser by accessing http://localhost:8080/widget-demo.html. You should see a page with the Livechat initiation icon at the bottom right.

   
   

For better performance, you can run this widget-demo.html on an HTTP server.