Skip to content

megawac/qwebirc-enhancements

Repository files navigation

qwebirc-mods Build Status

Qwebirc is intended to be a simple, intuitive and feature rich IRC client that operates out of the browser. This spiritual *fork* of Chris Porter's [qwebirc](http://qwebirc.org/) is a complete rewrite of the project in order to introduce more customability, add features introduced with HTML5, improve the extensibility of the code and revamp the ui (still qui). I began this project when I became frustrated trying to create a plugin atop of Qwebirc; flexibility and extensibility are two of the main focuses of the changes. I have also added multiple features, made code quality improvements, bug fixes, etc. Here's a ([Screenshot](http://puu.sh/4ANPf.png) [Screenshot 2](http://i.imgur.com/9Cee1iO.jpg)) of a live instance.

This is undergoing active development - a RC build is being staged

Installation:

  • Install node.js
  • Configure the qwebirc instance settings as described in configuration
  • Install development build dependencies using npm install in the base folder (reads in package.json)
  • Run grunt to build static files
  • Start up a iris or qwebirc with this repo's static files see #server. For testing I personally use the server in test/server with the base_url set to a live instance

Making changes

After making changes to source files run in the base directory and run grunt in the command line to recompile resources.

Configuration

You can set compile settings either in the gruntfile manually or setting the compile presets in app-config.yml and build.yml. A similar build step to the old compile.py build is in the works (see #17)

Making changes to most source files will require you to rebuild via grunt

####TODOs:

  • Add options for:
  • (mid) configure hotkeys
  • (major) Refactor python compile code to call appropriate Grunt build and set app options (#17)

##Server:
Requires a light modification of either qwebirc or iris in order to support localization and switching the index file to static.html. See commits below if you don't want to use my server fork

Twisted (or Iris)

I have an instance of the code running over twisted on the Geeks-IRC network at atf2.org