Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 90 lines (57 sloc) 2.182 kb
977598f @akavlie Add README.
authored
1 Web-IRC
2 =======
3
5568d5b @akavlie Add note about Subway
authored
4 Note
5 ----
6
7 I have stopped development on Web-IRC in favor of [Subway](https://github.com/thedjpetersen/subway),
8 a joint effort with another githubber. If you are interested in a web-based IRC client, look there.
9
10 https://github.com/thedjpetersen/subway
11
12
977598f @akavlie Add README.
authored
13 ### A web IRC client
14
247b6f7 @akavlie Small README tweaks.
authored
15 The goal for this project is to become the best in-browser IRC client available,
16 and bring the best ideas from modern web applications to IRC. It was inspired by a [request for improvements to qwebirc](https://github.com/paulirish/lazyweb-requests/issues/31)
17 by Paul Irish.
18
977598f @akavlie Add README.
authored
19 Web-IRC is based on [node.js](http://nodejs.org/) and
20 Martyn Smith's [node-irc](https://github.com/martynsmith/node-irc) on the backend,
21 and [Backbone.js](http://documentcloud.github.com/backbone/) and
22 [jQuery](http://jquery.com/) on the frontend.
23
24
25 Status
26 ------
27
28 The app is still in its early stages. Potential contributors should find plenty to do.
29
30 Here's what works:
31
dd88f53 @akavlie Feature list updated in README.
authored
32 - Choose nick/network/channel(s) to use at login
33 - Join channels
d482258 @akavlie Add ability to say stuff in channels.
authored
34 - Send messages to channels
977598f @akavlie Add README.
authored
35 - Switch between channel tabs, see chat output
36 - Leave channels
90824ba @akavlie Small update to functionality list to reflect private message support
authored
37 - Private messages
cf931eb @akavlie Fix node-irc package name; edit functionality list
authored
38 - Channel topics
977598f @akavlie Add README.
authored
39
40 Here's (a partial list of) what doesn't work yet:
41
42 - Status messages
dd88f53 @akavlie Feature list updated in README.
authored
43 - Listing channels
977598f @akavlie Add README.
authored
44
45 Design/UI/UX help also **desperately needed**.
46
8390f83 @akavlie Add installation instructions to README.
authored
47 Installation
48 ------------
49
9127ccc @akavlie Update README to reflect npm installation.
authored
50 1. Assuming you already have node.js & npm, run:
6a763c2 @akavlie Fix formatting of install section
authored
51
9127ccc @akavlie Update README to reflect npm installation.
authored
52 $ npm install -g web-irc
6a763c2 @akavlie Fix formatting of install section
authored
53
9127ccc @akavlie Update README to reflect npm installation.
authored
54 2. Launch the web server
6a763c2 @akavlie Fix formatting of install section
authored
55
9127ccc @akavlie Update README to reflect npm installation.
authored
56 $ web-irc
6a763c2 @akavlie Fix formatting of install section
authored
57
9127ccc @akavlie Update README to reflect npm installation.
authored
58 3. Point your browser at `http://localhost:8337/`
6a763c2 @akavlie Fix formatting of install section
authored
59
9127ccc @akavlie Update README to reflect npm installation.
authored
60 Development
61 -----------
62
63 Replace step 1 above with this:
64
65 $ git clone https://github.com/akavlie/web-irc
66 $ cd web-irc
67 $ npm link
68
69 this should install dependencies, and link the git checkout to your global
70 node_modules directory.
977598f @akavlie Add README.
authored
71
72 Rationale
73 ---------
74
75 Web-based IRC clients are quite popular, particularly as an in-page embed for
76 various open source projects and live shows. The ubiquitous choice at this time
77 is the aforementioned [qwebirc](http://qwebirc.org/).
78
79 Here are some popular sites that use (or link to) a web IRC client:
80
81 - [jQuery](http://docs.jquery.com/Discussion)
82 - [freenode](http://webchat.freenode.net/)
83 - [TWiT](http://twit.tv/)
84
85
86 License
87 -------
88
d482258 @akavlie Add ability to say stuff in channels.
authored
89 MIT licensed. See `LICENSE`.
Something went wrong with that request. Please try again.