Skip to content

Latest commit

 

History

History
30 lines (19 loc) · 1.67 KB

README.md

File metadata and controls

30 lines (19 loc) · 1.67 KB
Raw

Minimal Chat operator application

Minimal Chat is an open source live chat system providing live one on one messaging to a website visitor and an operator.

Minimal Chat is:

  • minimal: simple, lightweight, accessible
  • extensible: modular, pluggable, hookable, composable

We're glad you're interested in contributing, feel free to create an issue or pick one up but first check out our contributing doc and code of conduct. Check out our design documentation as well.

Screenshot

operator-screenshot-1

Development

Developing for the operator application is fairly straightforward with a few caveats. All of the Minimal Chat repositories are run through make. To get the application running:

  1. Clone the repository
  2. make dependencies
  3. make run

To have the operator communicate with your local daemon requires some confirguration. The operator application keeps a config.json file that it creates on run if it does not exist. It is recommended to let the application run once in disconnected mode rather than creating your own config.json.

  1. Once you've run the application once, find the config.json file.
  2. Open config.json, edit the "apiServer", set this to the IP and port that the daemon is running on. (e.g. http://localhost:8000, the default setting)