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