https://github.com/mtrpcic/WebIRC

WebSocket based IRC chatting through Twisted
https://github.com/mtrpcic/WebIRC

Last synced: about 2 months ago
JSON representation

WebSocket based IRC chatting through Twisted

• Host: GitHub
• URL: https://github.com/mtrpcic/WebIRC
• Owner: mtrpcic
• Created: 2010-11-15T06:14:23.000Z (almost 14 years ago)
• Default Branch: master
• Last Pushed: 2013-08-04T17:29:29.000Z (about 11 years ago)
• Last Synced: 2024-07-05T14:40:59.574Z (3 months ago)
• Language: JavaScript
• Homepage: https://github.com/mtrpcic/WebIRC
• Size: 70.3 KB
• Stars: 20
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.markdown

Awesome Lists containing this project

README

        
# WebIRC #

WebIRC is a Twisted based Web Server/IRC Client that allows you to communicate on IRC from your browser

without the need for a Java Applet or Flash components.  It makes use of the HTML5 WebSocket technology

# Running WebIRC #

To run WebIRC, you'll need the following packages:

* Python 2.6.x

* Twisted v8.2.0+

* [Mako](http://www.makotemplates.org/)

* [txwebsockets](https://github.com/gleicon/txwebsockets)

* A browser that supports the WebSocket protocol

Once all packages are installed, simply go into the root of the project and type the following into your terminal:

    python run.py

Then visit `localhost:8080` in your browser.

# Known Limitations #

* Bad form data on the home page will crash the server, as it is not validated

* Sometimes there is a race condition that causes the IRC connection to happen **before** the WebSocket is fully connected, and no data will show up in the browser chat window

* The 'New Message' field allows users to enter text before the client has actually joined the channel

# To Do #

* Add some form validation

* Add support for web-based actions (/nick, /action, /me)

* Automatically highlight hyperlinks in the chat panel

* Add CSS to highlight your username, and when somebody explicitly messages you

* Add support for multiple channels

* Add support for 1 on 1 messaging

* Add support for multiple clients attached to a single server

# Disclaimer #

This code is still under development, and as such, minor revisions may drastically change functionality.

Please keep this in mind when using WebIRC.

# Copyright and Licensing #

Copyright (c) 2010 Mike Trpcic, released under the MIT license