/client

Client library for Minimal Chat

Primary LanguageJavaScriptBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Minimal Chat client script

Build Status Coverage Status

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

client-screenshot-2

The client script is embedded into a html page just before the </body> tag.

Usage

<!-- Start of Async Minimal Chat Code -->
<script>
!function() {
  o = document.createElement("script"),
  o.type = "text/javascript", o.async = !0, o.crossorigin = "anonymous", o.src = "/mnml-0.2.0.min.js",
  n = document.getElementsByTagName("script")[0], n.parentNode.insertBefore(o, n);
}();
</script>
<!-- End of Async Minimal Chat Code -->

Development

Developing for the client is fairly straight forward. All of the Minimal Chat repositories are run through make. To get the code running:

  1. Clone the repository
  2. make dependencies
  3. make run
  4. Browse to http://localhost:3000