A bouncer client for IRC
JavaScript
Pull request Compare This branch is 378 commits behind thedjpetersen:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
assets
lib
views
.gitignore
README.md
package.json
subway

README.md

Subway

Subway is an IRC client/server combination. The server supports multiple simultaneous users. The client is a modern JavaScript-heavy web interface. Client/server communication is done with websockets (or best available fallback) via socket.io. If the the user is logged in the client will stay persistant and log the channel why the user is away.

The inspiration from this project was trying to watch a fellow programmer try to explain how to set up screen/irssi to a non-technical person.

Subway is built with node.js, Martyn Smith's node-irc, and MongoDB on the backend, and Backbone.js and jQuery on the frontend.

Try Subway on RideZap

Screenshots

Overview Chat

Installation

Should be something like this, once implemented:

  1. Assuming you already have node.js, npm, and mongo, run:

    $ npm install -g subway

  2. Launch the web server

    $ node bin/subway

  3. Point your browser at http://localhost:3000/

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.

Discussion on the client takes place on the freenode channel #subway.

History

Subway is a combination of two projects that started independently with a similar technology stack and similar aims:

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

Credits

Major Subway contributors include:

  • David Petersen, developer
  • Aaron Kavlie, developer
  • Jamie Soar, notification sounds
  • Some icons by Yusuke Kamiyamane. All rights reserved. Licensed under a Creative Commons Attribution 3.0 License.

License

Excepting third-party assets (licensed as specified in their respective files or directories), this project is covered by the MIT 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.