Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 112 lines (76 sloc) 3.647 kB
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
1 Subway
2 ======
04e52b3 Adding a README
David authored
3
cafe5aa @akavlie Misc. tweaks to README.
akavlie authored
4 Subway is an IRC client/server combination.
5 The server supports multiple simultaneous users. The client is a modern
6 JavaScript-heavy web interface. Client/server communication is done with
7490d57 Updating readme
David Petersen authored
7 websockets (or best available fallback) via socket.io. If the the user is
8 logged in the client will stay persistant and log the channel why the user is
9 away.
10
11 The inspiration from this project was trying to watch a fellow programmer try
12 to explain how to set up screen/irssi to a non-technical person.
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
13
cafe5aa @akavlie Misc. tweaks to README.
akavlie authored
14 Subway is built with [node.js](http://nodejs.org/) and
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
15 Martyn Smith's [node-irc](https://github.com/martynsmith/node-irc) on the backend,
16 and [Backbone.js](http://documentcloud.github.com/backbone/) and
17 [jQuery](http://jquery.com/) on the frontend.
18
d4f8fff Update readme
David Petersen authored
19 **[Try Subway on RideZap](http://ridezap.com:3000)**
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
20
7490d57 Updating readme
David Petersen authored
21 Screenshots
22 ------------
23 ![Overview](http://people.oregonstate.edu/~petersed/overview.png)
24 ![Chat](http://people.oregonstate.edu/~petersed/chat.png)
25
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
26 Installation
27 ------------
28
29 *Should be something like this, once implemented:*
30
7490d57 Updating readme
David Petersen authored
31 1. Assuming you already have node.js, npm, and mongo, run:
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
32
33 $ npm install -g subway
34
35 2. Launch the web server
36
ee81841 Fixing mistake in README
David authored
37 $ node bin/subway
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
38
7490d57 Updating readme
David Petersen authored
39 3. Point your browser at `http://localhost:3000/`
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
40
cafe5aa @akavlie Misc. tweaks to README.
akavlie authored
41
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
42 Development
43 -----------
44
45 *Should be about like this, once implemented:*
46
47 Replace step 1 above with this:
48
49 $ git clone https://github.com/thedjpetersen/subway.git
50 $ cd subway
51 $ npm link
52
53 this should install dependencies, and link the git checkout to your global
54 node_modules directory.
55
cafe5aa @akavlie Misc. tweaks to README.
akavlie authored
56
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
57 History
58 -------
59
dba9b54 @akavlie Add note about third-party asset licensing.
akavlie authored
60 Subway is a combination of two projects that started independently
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
61 with a similar technology stack and similar aims:
62
dba9b54 @akavlie Add note about third-party asset licensing.
akavlie authored
63 - [subway-web](https://github.com/thedjpetersen/subway-web) /
a0044eb @akavlie Formatting changes.
akavlie authored
64 [subway-server](https://github.com/thedjpetersen/subway-server)
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
65 by David Petersen
66 - [web-irc](https://github.com/akavlie/web-irc) by Aaron Kavlie
67
68 Its goals are twofold:
69 1) Become the best web-based IRC client available
70 2) Provide a really easy method of persistent IRC connections, available
71 from any web browser
72
73
002f40a @akavlie Add credits to README.
akavlie authored
74 Credits
75 -------
76
77 Major Subway contributors include:
78
79 - [David Petersen](https://github.com/thedjpetersen), developer
80 - [Aaron Kavlie](https://github.com/akavlie), developer
81 - [Jamie Soar](http://www.jamiesoarmusic.co.uk/), notification sounds
306eb41 @thedjpetersen Updating README
authored
82 - Some icons by Yusuke Kamiyamane. All rights reserved. Licensed under a Creative Commons Attribution 3.0 License.
002f40a @akavlie Add credits to README.
akavlie authored
83
dba9b54 @akavlie Add note about third-party asset licensing.
akavlie authored
84
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
85 License
86 -------
87
dba9b54 @akavlie Add note about third-party asset licensing.
akavlie authored
88 Excepting third-party assets (licensed as specified in their respective files
89 or directories), this project is covered by the MIT License:
90
91
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
92 The MIT License (MIT)
93 Copyright (c) 2011 David Petersen
94
95 Permission is hereby granted, free of charge, to any person obtaining a copy of
96 this software and associated documentation files (the "Software"), to deal in
97 the Software without restriction, including without limitation the rights to
98 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
99 of the Software, and to permit persons to whom the Software is furnished to do
100 so, subject to the following conditions:
101
102 The above copyright notice and this permission notice shall be included in all
103 copies or substantial portions of the Software.
104
105 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
106 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
107 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
108 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
109 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
110 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
111 SOFTWARE.
Something went wrong with that request. Please try again.