Git Product home page Git Product logo

webirc's Introduction

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
  • 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

webirc's People

Contributors

mtrpcic avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

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