Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 121 lines (82 sloc) 3.925 kb
28756ab Aaron Kavlie Add a bunch of stuff to the README.
akavlie authored
1 Subway
2 ======
04e52b3 Adding a README
David authored
3
bd36737 Aaron Kavlie A bunch of README changes:
akavlie authored
4 Subway is a web-based IRC client with a multi-user backend and a
3ce15c7 Divye Kapoor Small doc fix in the README.
divyekapoor authored
5 JavaScript-heavy UI. Frontend/backend communication is done with
bd36737 Aaron Kavlie 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 Aaron Kavlie 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 Aaron Kavlie 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 Aaron Kavlie 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 Aaron Kavlie 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 Aaron Kavlie 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 Aaron Kavlie Add a bunch of stuff to the README.
akavlie authored
29
129aa81 Vitor 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 Aaron Kavlie Add a bunch of stuff to the README.
akavlie authored
32
a376c78 John Fink npm install step in README.md
jbfink authored
33 2. Install the dependencies using npm:
34
35 $ npm install
36
37 3. Launch the web server
28756ab Aaron Kavlie Add a bunch of stuff to the README.
akavlie authored
38
129aa81 Vitor Pellegrino Fixing markdown format so installation instructions are correctly displa...
pellegrino authored
39 $ node subway
28756ab Aaron Kavlie Add a bunch of stuff to the README.
akavlie authored
40
a376c78 John Fink npm install step in README.md
jbfink authored
41 4. Point your browser at `http://localhost:3000/`
28756ab Aaron Kavlie Add a bunch of stuff to the README.
akavlie authored
42
cafe5aa Aaron Kavlie Misc. tweaks to README.
akavlie authored
43
45e205f Joey Aghion update Readme to describe Nodejitsu deployment
joeyAghion authored
44 Deployment
45 -----------
46 ### Nodejitsu
47 To deploy to Nodejitsu, update the `name` and `subdomain` values in `package.json` to the appropriate values for your app. Then:
48
49 $ jitsu env set PORT 80
50 $ jitsu deploy
51
52
28756ab Aaron Kavlie Add a bunch of stuff to the README.
akavlie authored
53 Development
54 -----------
55
bd36737 Aaron Kavlie A bunch of README changes:
akavlie authored
56 Discussion about the client takes place on the freenode channel **#subway**, and on
57 this repository's [Issues](https://github.com/thedjpetersen/subway/issues) page.
58 Contributors are welcome and greatly appreciated.
0dc270b Update README.md
David Petersen authored
59
cafe5aa Aaron Kavlie Misc. tweaks to README.
akavlie authored
60
28756ab Aaron Kavlie Add a bunch of stuff to the README.
akavlie authored
61 History
62 -------
63
dba9b54 Aaron Kavlie Add note about third-party asset licensing.
akavlie authored
64 Subway is a combination of two projects that started independently
28756ab Aaron Kavlie Add a bunch of stuff to the README.
akavlie authored
65 with a similar technology stack and similar aims:
66
dba9b54 Aaron Kavlie Add note about third-party asset licensing.
akavlie authored
67 - [subway-web](https://github.com/thedjpetersen/subway-web) /
a0044eb Aaron Kavlie Formatting changes.
akavlie authored
68 [subway-server](https://github.com/thedjpetersen/subway-server)
28756ab Aaron Kavlie Add a bunch of stuff to the README.
akavlie authored
69 by David Petersen
70 - [web-irc](https://github.com/akavlie/web-irc) by Aaron Kavlie
71
72 Its goals are twofold:
73 1) Become the best web-based IRC client available
74 2) Provide a really easy method of persistent IRC connections, available
75 from any web browser
76
bd36737 Aaron Kavlie A bunch of README changes:
akavlie authored
77 The inspiration for Subway was trying to watch a fellow programmer try
78 to explain how to set up screen/irssi to a non-technical person.
79
28756ab Aaron Kavlie Add a bunch of stuff to the README.
akavlie authored
80
002f40a Aaron Kavlie Add credits to README.
akavlie authored
81 Credits
82 -------
83
84 Major Subway contributors include:
85
86 - [David Petersen](https://github.com/thedjpetersen), developer
87 - [Aaron Kavlie](https://github.com/akavlie), developer
88 - [Jamie Soar](http://www.jamiesoarmusic.co.uk/), notification sounds
bd36737 Aaron Kavlie A bunch of README changes:
akavlie authored
89 - Yusuke Kamiyamane, some icons
002f40a Aaron Kavlie Add credits to README.
akavlie authored
90
e2de5dc Update README.md
David Petersen authored
91 **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**
92
dba9b54 Aaron Kavlie Add note about third-party asset licensing.
akavlie authored
93
28756ab Aaron Kavlie Add a bunch of stuff to the README.
akavlie authored
94 License
95 -------
96
dba9b54 Aaron Kavlie Add note about third-party asset licensing.
akavlie authored
97 Excepting third-party assets (licensed as specified in their respective files
98 or directories), this project is covered by the MIT License:
99
100
28756ab Aaron Kavlie Add a bunch of stuff to the README.
akavlie authored
101 The MIT License (MIT)
102 Copyright (c) 2011 David Petersen
103
104 Permission is hereby granted, free of charge, to any person obtaining a copy of
105 this software and associated documentation files (the "Software"), to deal in
106 the Software without restriction, including without limitation the rights to
107 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
108 of the Software, and to permit persons to whom the Software is furnished to do
109 so, subject to the following conditions:
110
111 The above copyright notice and this permission notice shall be included in all
112 copies or substantial portions of the Software.
113
114 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
115 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
116 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
117 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
118 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
119 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
120 SOFTWARE.
Something went wrong with that request. Please try again.