Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/robinjmurphy/help
Live chat support powered by IRC
https://github.com/robinjmurphy/help
Last synced: about 1 month ago
JSON representation
Live chat support powered by IRC
- Host: GitHub
- URL: https://github.com/robinjmurphy/help
- Owner: robinjmurphy
- Created: 2015-08-14T07:35:38.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-08-16T09:34:03.000Z (over 9 years ago)
- Last Synced: 2024-08-01T12:33:27.538Z (4 months ago)
- Language: JavaScript
- Homepage: https://help-demo.herokuapp.com/
- Size: 514 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-starred - robinjmurphy/help - Live chat support powered by IRC (others)
README
# help
> Live chat support powered by IRC
Users chat in their browser – you respond using IRC.
Join #help-demo on Freenode and start a chat at https://help-demo.herokuapp.com/ for a live demo.
## How it works
The _help_ server connects to your IRC server and creates an ad-hoc channel for each chat. It lets you know when a chat is created so you can join the channel and provide support. Messages are passed between the browser and the IRC server using WebSockets.
## Installation
```
git clone https://GitHub.com/robinjmurphy/help.git
cd help
npm install
node server.js
```
Open http://127.0.0.1:3000 in your web browser, enter your name and click _Start a chat_ to open a chat window. The server tries to connect to `localhost:6667` by default, but you can use a public server like [Freenode](https://freenode.net/) if you're happy for your chats to be public.
## Configuration
Everything about help is configurable; from the basic IRC connection settings to the messages that it sends to you and your users. Edit the [`settings.js`](settings.js) file to configure the server, where each setting is documented.
## Launching a chat from your website
The server's index page includes a link to start a new chat. You can create you own button on your website just by linking to the server's `/chat` page in a new window.
To pass arbitrary data to the chat window from your website (a customer ID or name, for example) just set the query string when linking to the `/chat` page. All of the query parameters are accessible as Mustashe variables when you configure the message that is sent when someone joins a chat.
```
/chat?name=robin
```
In [`settings.js`](settings.js):
```
join: "You're chatting to {{name}}"
```
## Theming
The chat window comes with a basic theme. You can override any part of the interface by adding your own styles to [`public/css/theme.css`](public/css/theme.css).
## Contributors
* [@robinjmurphy](https://github.com/robinjmurphy)
* [@mrwillihog](https://github.com/mrwillihog)