diff --git a/README.md b/README.md index d0fc7b9f4..adaaa6ec4 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,68 @@ [![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/RocketChat/Rocket.Chat.Livechat.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/RocketChat/Rocket.Chat.Livechat/context:javascript) [![Total alerts](https://img.shields.io/lgtm/alerts/g/RocketChat/Rocket.Chat.Livechat.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/RocketChat/Rocket.Chat.Livechat/alerts/) [![Storybook](https://cdn.jsdelivr.net/gh/storybooks/brand@master/badge/badge-storybook.svg)](https://rocketchat.github.io/Rocket.Chat.Livechat) -## CLI Commands + +Currently, it's very common to find chat pop-ups when you're browsing websites. + +Those widgets, at Rocket.Chat, are called **LiveChat**. + +**LiveChat** is a small and lightweight application designed to provide B2C (Business-to-customer) communication between Agents and website visitors and is developed with [Preact](https://preactjs.com). + +## Running a development environment + +With your **Rocket.chat** running locally at http://localhost:3000 +
+ +1. Install all node dependencies. +``` bash +yarn +``` + +2. Build preact application to `/build` folder +``` bash +yarn dev +``` + +3. In another terminal, run webpack with hot reload at http://localhost:8080 +``` bash +yarn start +``` + +4. Open this file below in your browser +``` bash +widget-demo.html +``` + +*OBS: For a better performance, you can run this `widget-demo.html` on a [http server](https://github.com/http-party/http-server).* + +## Different host + +To select a different host on your local widget, check this configuration at `/src/api.js` file. + +``` javascript +const host = window.SERVER_URL + || queryString.parse(window.location.search).serverUrl + || (process.env.NODE_ENV === 'development' ? 'http://localhost:3000' : null); +``` + +Here, you can change to your new configuration. + +``` javascript +const host = window.SERVER_URL + || queryString.parse(window.location.search).serverUrl + || (process.env.NODE_ENV === 'development' ? 'https://your.rocketserver.com' : null); +``` + +## Available CLI Commands ``` bash # install dependencies yarn # serve with hot reload at localhost:8080 +yarn start + +# build preact application to "build" folder yarn dev # build for production with minification diff --git a/widget-demo.html b/widget-demo.html index 85cb7197c..058961f03 100644 --- a/widget-demo.html +++ b/widget-demo.html @@ -48,13 +48,9 @@ var h = d.getElementsByTagName(s)[0], j = d.createElement(s); j.async = true; - j.src = '/livechat/1.0.0/rocketchat-livechat.min.js?_=' + Math.random(); + j.src = 'build/rocketchat-livechat.min.js?_=' + Math.random(); h.parentNode.insertBefore(j, h); - })(window, document, 'script', '/livechat?version=1.0.0'); - - RocketChat(function() { - this.setCustomField('key-test', 'value test'); - }); + })(window, document, 'script', 'http://localhost:8080');