Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 112 lines (76 sloc) 3.71 kb
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
1 Subway
2 ======
04e52b3 Adding a README
David authored
3
bd36737 @akavlie A bunch of README changes:
akavlie authored
4 Subway is a web-based IRC client with a multi-user backend and a
3ce15c7 @divyekapoor Small doc fix in the README.
divyekapoor authored
5 JavaScript-heavy UI. Frontend/backend communication is done with
bd36737 @akavlie A bunch of README changes:
akavlie authored
6 websockets (or best available fallback where not available).
7 The backend supports connection persistence and optional logging when the
8 browser disconnects.
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
9
11faffe Updating readme
David Petersen authored
10 Subway is built with [node.js](http://nodejs.org/),
bd36737 @akavlie A bunch of README changes:
akavlie authored
11 [node-irc](https://github.com/martynsmith/node-irc)
12 and [MongoDB](http://www.mongodb.org/) on the backend,
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
13 and [Backbone.js](http://documentcloud.github.com/backbone/) and
14 [jQuery](http://jquery.com/) on the frontend.
15
d4f8fff Update readme
David Petersen authored
16 **[Try Subway on RideZap](http://ridezap.com:3000)**
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
17
7490d57 Updating readme
David Petersen authored
18 Screenshots
19 ------------
20 ![Overview](http://people.oregonstate.edu/~petersed/overview.png)
21 ![Chat](http://people.oregonstate.edu/~petersed/chat.png)
22
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
23 Installation
24 ------------
25
26 *Should be something like this, once implemented:*
27
7490d57 Updating readme
David Petersen authored
28 1. Assuming you already have node.js, npm, and mongo, run:
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
29
129aa81 @pellegrino Fixing markdown format so installation instructions are correctly displa...
pellegrino authored
30 $ git clone https://github.com/thedjpetersen/subway.git
31 $ cd subway
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
32
a376c78 @jbfink npm install step in README.md
jbfink authored
33 2. Install the dependencies using npm:
34
53b8a84 @jbfink Fixed formatting in README.md
jbfink authored
35 $ npm install
a376c78 @jbfink npm install step in README.md
jbfink authored
36
37 3. Launch the web server
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
38
129aa81 @pellegrino Fixing markdown format so installation instructions are correctly displa...
pellegrino authored
39 $ node subway
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
40
a376c78 @jbfink npm install step in README.md
jbfink authored
41 4. Point your browser at `http://localhost:3000/`
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
42
cafe5aa @akavlie Misc. tweaks to README.
akavlie authored
43
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
44 Development
45 -----------
46
bd36737 @akavlie A bunch of README changes:
akavlie authored
47 Discussion about the client takes place on the freenode channel **#subway**, and on
48 this repository's [Issues](https://github.com/thedjpetersen/subway/issues) page.
49 Contributors are welcome and greatly appreciated.
0dc270b Update README.md
David Petersen authored
50
cafe5aa @akavlie Misc. tweaks to README.
akavlie authored
51
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
52 History
53 -------
54
dba9b54 @akavlie Add note about third-party asset licensing.
akavlie authored
55 Subway is a combination of two projects that started independently
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
56 with a similar technology stack and similar aims:
57
dba9b54 @akavlie Add note about third-party asset licensing.
akavlie authored
58 - [subway-web](https://github.com/thedjpetersen/subway-web) /
a0044eb @akavlie Formatting changes.
akavlie authored
59 [subway-server](https://github.com/thedjpetersen/subway-server)
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
60 by David Petersen
61 - [web-irc](https://github.com/akavlie/web-irc) by Aaron Kavlie
62
63 Its goals are twofold:
64 1) Become the best web-based IRC client available
65 2) Provide a really easy method of persistent IRC connections, available
66 from any web browser
67
bd36737 @akavlie A bunch of README changes:
akavlie authored
68 The inspiration for Subway was trying to watch a fellow programmer try
69 to explain how to set up screen/irssi to a non-technical person.
70
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
71
002f40a @akavlie Add credits to README.
akavlie authored
72 Credits
73 -------
74
75 Major Subway contributors include:
76
77 - [David Petersen](https://github.com/thedjpetersen), developer
78 - [Aaron Kavlie](https://github.com/akavlie), developer
79 - [Jamie Soar](http://www.jamiesoarmusic.co.uk/), notification sounds
bd36737 @akavlie A bunch of README changes:
akavlie authored
80 - Yusuke Kamiyamane, some icons
002f40a @akavlie Add credits to README.
akavlie authored
81
e2de5dc Update README.md
David Petersen authored
82 **The logo right now is a Gowalla icon, we are not planning on keeping this, we are only planning on using it as a placeholder**
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.