Repository files navigation

Relay.js is a web-based IRC client that focuses on making IRC less intimidating and easier to use.

• This is only a demonstration server. It may break, crash, or stall at any time without warning. It's highly recommended that you host your own instance of Relay.js for prolonged use.

• Simple, usability-driven interface
• Dynamic embedding of content ( links, images, Gists, YouTube videos )
• Support for multiple connections
• Emoticons ( viahttp://www.emoji-cheat-sheet.com/ )

• Additional content embedding ( Tweets, Codepen, Open Graph, etc )
• Rearrangeable, modular interface
• Interface elements for certain IRC commands, such as banning/kicking a user
• Tab completion for usernames, emoticons, certain commands
• Tests
• Persistent connections (persistent connections should be handled by some kind ofbouncer)
• Logging

• Install the latest version ofnode.js
• Pull this repository
• Runnpm install in the base directory
• Compile assets withgrunt build command
• Runnode relay.js orgrunt dev
• Navigate tohttp://localhost:8080

If you plan on doing development, you'll want to installGrunt. Runninggrunt dev (ornpm 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 withgrunt -h.

Relay.js supports simple server configuration viaconfig.js and URL parameters. Theconfig.js file must simply export a javascript object with the desired properties filled in. Current configuration options are as follows:

• defaultsobject - A set of default options to use on initial load. Includesserver andchannels.
• defaults.serverobject - An object specifying a preset server to connect to. Iflocked is set totrue, these settings cannot be overridden, and by default the user is limited to a single connection. Parameters arehost,port,ssl, andpassword.
• defaults.nickstring - A nick that auto populates the 'Nick' input in the connect dialog.
• defaults.channelsarray - An array of channels that populate the 'Channels' input on the connect dialog.
• max_connectionsinteger - The maximum number of connections that can be made from a single client. Whendefaults.server.locked is set, this will default to1.

To set these options, just make aconfig.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 inconfig.js, except for locked parameters. The following parameters are available:

• server - The URL of an IRC server (ex: "irc.freenode.net"). Maps todefaults.server.host.
• port - The port of an IRC server (ex: 9001). Maps todefaults.server.port.
• ssl - Connect with SSL (ex: true). Maps todefaults.server.ssl.
• nick - The default nick to connect with (ex: "Fauntleroy"). Maps todefaults.nick.
• channels - A comma separated list of channels to join (ex: "relay.js,tksync"). Maps todefaults.channels.

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 )