Git Product home page Git Product logo

kiwiirc's Introduction

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:

Development environment

# install dependencies
yarn install

# 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+

Thanks

Providing sponsorship to the Kiwi IRC project helps keep kiwiirc.com free to use and makes the ongoing development possible. Without these Sponsors development would be much slower so many thanks to these!

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.

kiwiirc's People

Contributors

prawnsalad avatar itsonlybinary avatar allanocelot avatar iwalkalone69 avatar srmcgann avatar vith avatar thebeerbarian avatar zappatta avatar winrey avatar pedrovr- avatar corychaplin avatar arkadietz avatar shalokshalom avatar strategy47 avatar tehpegasus avatar yanickfrehner avatar mestaritonttu avatar

Watchers

Gabor 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.