@chatwoot/ui

Note: This repository is a POC. For any issues or fixes please use : https://github.com/chatwoot/chatwoot Always update the src directory to the latest chatwoot version before starting to work over it.

Prerequisite

Clone the repo into your local development environment.

Update to latest chatwoot UI (optional)

If you want to work over the latest chatwoot UI, replace the src directory contents in this repo with the latest chatwoot app/javascript folder.

Doing this step will require you to update the dependencies accordingly in your package.json if you face errors

Run Chatwoot API server

Run the Chatwoot server in API only mode. You can do this by setting the Environment variable CW_API_ONLY_SERVER to true before starting the chatwoot app.

Project setup

cp .env.example .env

yarn install

Compiles and hot-reloads for development

yarn serve

Compiles and minifies for production

yarn build

Lints and fixes files

yarn lint

Customize the API Host or Websocket URL

HOST_URL, API_HOST and WEBSOCKET_URL can be configured via environment variable during build time, if you would like to see the entire config, go to vue/config.js.

The basic config is of the format shown below.

window.chatwootConfig = {
  hostURL: 'http://localhost:8080',
  fbAppId: '',
  signupEnabled: true,
  enabledLanguages: [
    {
      "name":"English (en)",
      "iso_639_1_code":"en"
    }
  ],
  selectedLocale: 'en',
  apiHost: 'http://localhost:3000',
  websocketURL: 'ws://localhost:3000'
}

hostURL - This is the URL at which frontend app will be deployed.
fbAppId - This is Facebook Developer Application ID, used if FB integration needs to enabled.
signupEnabled - This is the flag used to disable signup from frontend, you would have disable the signups in the API as well separately.
enabledLanugages - List of locales available.
selectedLocale - Currently active locale, default en.
apiHost - Base URL of Chatwoot API, make sure that the Chatwoot server is running on API mode, other APIs will fail.
websocketURL - Base URL to connect to websocket. If you are running a production server then it would be wss://<app-domain.com>

Customize build configuration

See Configuration Reference.