README.md

   1 ### Kiwi IRC - A hand-crafted IRC client
   2 Kiwi IRC is a fully featured IRC client that can be extended to suit almost any needs.
   3 Using the web application is extremly simple even without any IRC knowledge as all the common needs are built directly into the UI.
   4
   5 For more information see https://kiwiirc.com or live instance of the application can be found at https://kiwiirc.com/client/.
   6 Our development IRC channel is on the Freenode network, irc.freenode.net #kiwiirc.
   7
   8 [![Visit our IRC channel](https://kiwiirc.com/buttons/irc.freenode.net/kiwiirc.png)](https://kiwiirc.com/client/irc.freenode.net/#kiwiirc)
   9
  10
  11 ### Installation
  12
  13 *Note: This requires Node.js to run. Make sure you have installed Node.js first! http://nodejs.org/download/*
  14
  15 1. Download the Kiwi source or clone the git repository:
  16
  17     `$ git clone git@github.com:prawnsalad/KiwiIRC.git && cd KiwiIRC`
  18
  19 2. Install the dependencies:
  20
  21     `$ npm install`
  22
  23 3. Copy and edit the configuration file as needed:
  24
  25     `$ cp config.example.js config.js`
  26
  27     `$ nano config.js`
  28
  29 4.  Make sure the client code is built:
  30
  31     `$ ./kiwi build`
  32
  33
  34 ### Running
  35 From the source folder: `$ ./kiwi start`
  36
  37 You can also run kiwi in the foreground to see any output by using the `-f` flag. Eg: `$ ./kiwi -f`
  38
  39 Open your new Kiwi instance in your browser. By default: http://localhost:7778/
  40
  41
  42 ### Bugs
  43 Report bugs using the issue tracker on github: https://github.com/prawnsalad/KiwiIRC/issues
  44
  45 ### Licence
  46 GNU Affero
  47 http://www.gnu.org/licenses/agpl.html
  48
  49
  50 ### Thanks to
  51 The KiwiIRC logo credited to Michael Drahony (www.drahony.com)