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 and make sure the client code is built:
  15
  16     `$ npm install`
  17
  18     `$ node client/assets/dev/build.js`
  19
  20 3. Copy and edit the configuration file as needed:
  21
  22     `$ cp config.example.js config.js`
  23
  24     `$ nano config.js`
  25
  26
  27 ### Running
  28 From the source folder: `$ ./kiwi start`
  29
  30 You can also run kiwi in the foreground to see any output by using the `-f` flag. Eg: `$ ./kiwi -f`
  31
  32 Open your new Kiwi instance in your browser. By default: http://localhost:7778/
  33
  34
  35 ### Bugs
  36 Report bugs using the issue tracker on github: https://github.com/prawnsalad/KiwiIRC/issues
  37
  38 ### Licence
  39 GNU Affero
  40 http://www.gnu.org/licenses/agpl.html
  41
  42
  43 ### Thanks to
  44 The KiwiIRC logo credited to Michael Drahony (www.drahony.com)