Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
115 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -1,3 +1,88 @@ | |||
## Subway | Subway | ||
====== | |||
|
|
||
An IRC server client combination. | *(Note: this is aspirational. Not implemented yet!)* | ||
|
|||
Subway is an IRC client/server combination. The server works for multiple simultaneous users, with optional persistent connections and logging. The client is a modern JavaScript-heavy web interface. Server/client communication is done with websockets (or best available fallback) via socket.io. | |||
|
|||
Subway utilizes [node.js](http://nodejs.org/) and | |||
Martyn Smith's [node-irc](https://github.com/martynsmith/node-irc) on the backend, | |||
and [Backbone.js](http://documentcloud.github.com/backbone/) and | |||
[jQuery](http://jquery.com/) on the frontend. | |||
|
|||
|
|||
Status | |||
------ | |||
|
|||
Nothing works yet. Functionality to come shortly. If you'd like to contribute, | |||
there is plenty to do. Tickets for needed functionality also to come shortly. | |||
|
|||
Installation | |||
------------ | |||
|
|||
*Should be something like this, once implemented:* | |||
|
|||
1. Assuming you already have node.js & npm, run: | |||
|
|||
$ npm install -g subway | |||
|
|||
2. Launch the web server | |||
|
|||
$ subway | |||
|
|||
3. Point your browser at `http://localhost:8337/` | |||
|
|||
Development | |||
----------- | |||
|
|||
*Should be about like this, once implemented:* | |||
|
|||
Replace step 1 above with this: | |||
|
|||
$ git clone https://github.com/thedjpetersen/subway.git | |||
$ cd subway | |||
$ npm link | |||
|
|||
this should install dependencies, and link the git checkout to your global | |||
node_modules directory. | |||
|
|||
History | |||
------- | |||
|
|||
Subway is a combination of two projects that started independently | |||
with a similar technology stack and similar aims: | |||
|
|||
- [subway-web](https://github.com/thedjpetersen/subway-web) / | |||
[subway-server](https://github.com/thedjpetersen/subway-server) | |||
by David Petersen | |||
- [web-irc](https://github.com/akavlie/web-irc) by Aaron Kavlie | |||
|
|||
Its goals are twofold: | |||
1) Become the best web-based IRC client available | |||
2) Provide a really easy method of persistent IRC connections, available | |||
from any web browser | |||
|
|||
|
|||
License | |||
------- | |||
|
|||
The MIT License (MIT) | |||
Copyright (c) 2011 David Petersen | |||
|
|||
Permission is hereby granted, free of charge, to any person obtaining a copy of | |||
this software and associated documentation files (the "Software"), to deal in | |||
the Software without restriction, including without limitation the rights to | |||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies | |||
of the Software, and to permit persons to whom the Software is furnished to do | |||
so, subject to the following conditions: | |||
|
|||
The above copyright notice and this permission notice shall be included in all | |||
copies or substantial portions of the Software. | |||
|
|||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -1,7 +1,4 @@ | |||
#!/usr/bin/env node | #!/usr/bin/env node | ||
|
|
||
var Subway = require('../lib/subway').Subway; | var subway = require('../lib/subway').subway; | ||
|
subway.start(); | ||
var subway = new Subway(); | |||
|
|||
subway.start(); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -1,16 +1,18 @@ | |||
var irc = require('irc'); | var irc = require('irc'), | ||
var io = require('socket.io'); | app = require('./webserver').app | ||
var app = require('./webserver').app; | io = require('socket.io'); | ||
|
|
||
var Subway = exports.Subway = function() { | var Subway = function() { | ||
var self = this; | var self = this; | ||
self.app = app; | self.app = app; | ||
self.io = io; | self.io = io; | ||
self.irc = irc; | self.irc = irc; | ||
} | } | ||
|
|
||
Subway.prototype.start = function () { | Subway.prototype.start = function () { | ||
var self = this; | var self = this; | ||
self.app.listen(3000); | self.app.listen(3000); | ||
self.io.listen(self.app); | self.io.listen(self.app); | ||
} | } | ||
|
|||
exports.subway = new Subway(); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -1,19 +1,21 @@ | |||
{ | { | ||
"author": "David Petersen <davjpetersen@gmail.com>", | |||
"name": "subway", | "name": "subway", | ||
"description": "A browser-based IRC client with server", | |||
"keywords": ["irc"], | |||
"author": "David Petersen <davjpetersen@gmail.com>", | |||
"version": "0.1.0", | "version": "0.1.0", | ||
"main": "./lib/hookio", | "main": "./lib/subway.js", | ||
"bin": { | "bin": { | ||
"subway": "./bin/subway" | "subway": "./bin/subway" | ||
}, | }, | ||
"engines": { | "engines": { | ||
"node": ">= v0.4.7" | "node": ">=0.6.1" | ||
}, | }, | ||
"dependencies": { | "dependencies": { | ||
"express":"", | "express": "", | ||
"jade":"", | "jade": "", | ||
"connect-assets":"", | "connect-assets": "", | ||
"irc": "", | "irc": "", | ||
"socket.io":"" | "socket.io": "" | ||
} | } | ||
} | } |