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 http://kiwiirc.com or an example of the application can be found at http://kiwiirc.com/client/
   6
   7
   8 ### Installation
   9
  10 1. Download the Kiwi source or clone the git repository:
  11
  12     `$ git clone git@github.com:prawnsalad/KiwiIRC.git && cd KiwiIRC`
  13
  14 2. Install the dependancies:
  15
  16     `$ npm install`
  17
  18 3. Copy and edit the configuration file as needed:
  19
  20     `$ cp config.example.js config.js`
  21
  22     `$ nano config.js`
  23
  24 4.  Make sure the client code is built:
  25
  26     `$ ./kiwi build`
  27
  28
  29 ### Running
  30 From the source folder: `$ ./kiwi start`
  31
  32 You can also run kiwi in the foreground to see any output by using the `-f` flag. Eg: `$ ./kiwi -f`
  33
  34 Open your new Kiwi instance in your browser. By default: http://localhost:7778/
  35
  36
  37 ### Bugs
  38 Report bugs using the issue tracker on github: https://github.com/prawnsalad/KiwiIRC/issues
  39
  40 ### Licence
  41 GNU Affero
  42 http://www.gnu.org/licenses/agpl.html
  43
  44
  45 ### Thanks to
  46 The KiwiIRC logo credited to Michael Drahony (www.drahony.com)