Kiwi IRC

The next generation of the Kiwi IRC web based IRC client

Easy supported ways to install Kiwi IRC

If you just want to run Kiwi IRC and not modify it then pre-built and ready to use packages/installers/archives can be found here: https://kiwiirc.com/downloads/index.html

Dependencies

Before you can build or start to develop on Kiwi IRC, make sure to have the following installed on your system:

Nodejs
yarn

Development environment

# install dependencies
yarn install

# Optionally link git pre-commit linting hook
ln -s $PWD/scripts/pre-commit .git/hooks/

# development web server with hot reload at http://localhost:8080/
yarn run dev

Source files are linted automatically and will fail on any linting errors.

Building for production

# install dependencies
$ yarn install

# build for production with minification
$ yarn run build

Built files that can be uploaded to your webserver will be placed in the dist/ folder.

Configuration

By default, the client will load the /static/config.json file on startup which contains any runtime configuration. When in the development environment this can be found in static/config.json

Getting started

If you just want to run Kiwi IRC and not modify it then pre-built and ready to use packages/installers/archives can be found here: https://kiwiirc.com/downloads/index.html

Just looking to build a theme? Try the online theme builder

This repository only contains the client side (the website). By default it will connect to IRC networks via kiwiirc.com servers while you are developing locally. To use your own server you either need to be using a websocket capable IRC server (none yet support this) or need to be connecting to a Kiwi IRC server which can be found here.

The client side files built from this repository may be hosted anywhere - Apache, Nginx, the Kiwi IRC server, your CDN.

Browser support

Kiwi IRC is tested on the below browsers. Other browsers are not checked and may have trouble running Kiwi IRC.

Chrome
Chrome Mobile (Android)
Firefox
IE11
Safari 9+

License

   Copyright 2018 Kiwi IRC

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

milorddev / kiwiirc