Relay.js is a web-based IRC client that focuses on making IRC less intimidating and easier to use.
npm install
in the base directorygrunt build
commandnode relay.js
or grunt dev
If you plan on doing development, you'll want to install Grunt. Running grunt dev
(or npm run dev
if you don't have/want Grunt globally installed) will build the assets (unminified), start the server, and watch + recompile the assets on change. A full list of grunt tasks can be seen with grunt -h
.
Relay.js supports simple server configuration via config.js
and URL parameters. The config.js
file must simply export a javascript object with the desired properties filled in. Current configuration options are as follows:
true
, these settings cannot be overridden, and by default the user is limited to a single connection. Parameters are host, port, ssl, and password.defaults.server.locked
is set, this will default to 1.To set these options, just make a config.js
in the main directory of the app. Here's a quick example:
module.exports = {
"defaults": {
"server": {
"host": "irc.freenode.net"
},
"channels": [
"#relay.js"
]
},
"max_connections": 3
}
Some defaults may also be set using URL parameters. Defaults specified in the URL will override those in config.js
, except for locked parameters. The following parameters are available:
Contributing to Relay.js is simple: just create a fork, make a new branch, and submit a pull request when you're done. Try to keep your code style similar to the original and comment anything worth mentioning. Discussion is encouraged in issues and pull requests. Relay.js can be found in the channel #relay.js on Freenode.
MIT License ( see LICENSE.md )