Git Product home page Git Product logo

kiwiirc's Introduction

Kiwi IRC

A versatile web based messenger using IRC

  • 100% static files. Host with your favourite web server or a CDN
  • For single networks, bouncer hosts, or a personal generic IRC client that remembers your networks
  • Works out of the box with a default IRC network - or use your own
  • Single or multiple IRC network connections
  • Multiple layouts for small areas or full page layouts
  • Light and dark modes
  • Desktop notifications
  • Extremely versatile via a single JSON config file at runtime
  • Themable and rich plugin support such as file uploading and video calling
  • Team mode for workplaces

Connection modes:

  • Directly to a websocket IRC server
  • Connect via the webircgateway websocket proxy for normal IRC servers
  • Stay connected with KiwiBNC

Installing Kiwi IRC

If you just want to embed an IRC client on your website, you can generate a custom client hosted by kiwiirc.com using the simple client builder, https://kiwiirc.com/clientbuilder/

To install Kiwi IRC on your own server, pre-built and ready to use installers can be found at the downloads page, https://kiwiirc.com/downloads/

Building from source

Dependencies

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

Building for production

# Install dependencies
$ yarn install

# Build Kiwi IRC into the dist/ folder
$ yarn run build

Note: Be sure to copy the files from the dist/ folder to your webserver! This folder will be overwritten each time it is built.

Development environment

Kiwi IRC is built using Vuejs, webpack and babel.

# Install dependencies
yarn install

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

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

Note: Do not use this development environment on your live website. It is slow, very large, and unsecure.

Configuration

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

Browser support

Kiwi IRC is tested on all modern browsers and IE11. Other browsers are not actively tested and may have trouble running Kiwi IRC.

  • Chrome
  • Chrome Mobile (Android)
  • Firefox
  • IE11
  • Safari 9+

kiwiirc's People

Contributors

prawnsalad avatar itsonlybinary avatar allanocelot avatar tralves avatar iwalkalone69 avatar 790 avatar srmcgann avatar thebeerbarian avatar westor7 avatar vith avatar siltwood avatar zappatta avatar winrey avatar corychaplin avatar pedrovr- avatar digitalcircuit avatar half-duplex avatar dependabot[bot] avatar arkadietz avatar danieloaks avatar hhirtz avatar chesty avatar mohan43u avatar mrgrays avatar shalokshalom avatar slingamn avatar strategy47 avatar tehpegasus avatar yanickfrehner avatar mestaritonttu avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.