7bp / nirc

A simple web browser IRC client written in Node.js.

nirc

A simple web browser IRC client written in Node.js.

Demo

http://nirc.herokuapp.com/

Setup

Node.js and NPM are required and should be setup before attempting to setup nirc.

• Clone the repo and cd into the directory:

      $ git clone https://github.com/cjstewart88/nirc.git
      $ cd nirc

• Install dependencies using npm:

      $ npm install

• Build the application:

      $ grunt build

• Start the service:

      $ node server

• Open the app in your browser at http://localhost:3000/.

Themes

Roll your own theme by:

1. Create a folder for your theme in the src/stylesheets/themes directory.
2. Add your custom css and images to this folder.
3. Update line 3 in src/nirc/javascripts/nirc.js to include your new theme.
4. If you're proud of your theme open a PR to include it!

Contribute

This project is available under the MIT License. Feel free to open PRs or issues to help make nirc better.

Basic Git Workflow

• Clone the repo and cd into the directory:

      $ git clone https://github.com/cjstewart88/nirc.git
      $ cd nirc

• Make a branch for your fixes or new features:

      $ git checkout -b branch_name_here

• Make your changes, test to make sure they work and make sure no previous functionality is broken.

• Push to your fork Open a Pull Request!

Our IRC Channel

Join us in #nirc on irc.freenode.net for disscussion or to just say hey!