Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 125 lines (85 sloc) 4.169 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
7490d57 Updating readme
David Petersen authored
16 Screenshots
17 ------------
18 ![Overview](http://people.oregonstate.edu/~petersed/overview.png)
19 ![Chat](http://people.oregonstate.edu/~petersed/chat.png)
20
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
21 Installation
22 ------------
23
24 *Should be something like this, once implemented:*
25
7490d57 Updating readme
David Petersen authored
26 1. Assuming you already have node.js, npm, and mongo, run:
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
27
129aa81 @pellegrino Fixing markdown format so installation instructions are correctly displa...
pellegrino authored
28 $ git clone https://github.com/thedjpetersen/subway.git
29 $ cd subway
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
30
a376c78 @jbfink npm install step in README.md
jbfink authored
31 2. Install the dependencies using npm:
32
53b8a84 @jbfink Fixed formatting in README.md
jbfink authored
33 $ npm install
a376c78 @jbfink npm install step in README.md
jbfink authored
34
35 3. Launch the web server
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
36
129aa81 @pellegrino Fixing markdown format so installation instructions are correctly displa...
pellegrino authored
37 $ node subway
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
38
a376c78 @jbfink npm install step in README.md
jbfink authored
39 4. 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
45e205f @joeyAghion update Readme to describe Nodejitsu deployment
joeyAghion authored
42 Deployment
43 -----------
44 ### Nodejitsu
45 To deploy to Nodejitsu, update the `name` and `subdomain` values in `package.json` to the appropriate values for your app. Then:
46
0a5c947 @davidbanham Completed instructions for deploying on nodejitsu with a database.
davidbanham authored
47 $ jitsu databases create mongo subway
48
49 Now change the line `mongoose.connect('mongodb://localhost/subway');` in lib/irchandler.js to the connect URI you got back from jitsu. Then:
50
45e205f @joeyAghion update Readme to describe Nodejitsu deployment
joeyAghion authored
51 $ jitsu env set PORT 80
52 $ jitsu deploy
53
54
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
55 Development
56 -----------
57
bd36737 @akavlie A bunch of README changes:
akavlie authored
58 Discussion about the client takes place on the freenode channel **#subway**, and on
59 this repository's [Issues](https://github.com/thedjpetersen/subway/issues) page.
60 Contributors are welcome and greatly appreciated.
0dc270b Update README.md
David Petersen authored
61
cafe5aa @akavlie Misc. tweaks to README.
akavlie authored
62
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
63 History
64 -------
65
dba9b54 @akavlie Add note about third-party asset licensing.
akavlie authored
66 Subway is a combination of two projects that started independently
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
67 with a similar technology stack and similar aims:
68
dba9b54 @akavlie Add note about third-party asset licensing.
akavlie authored
69 - [subway-web](https://github.com/thedjpetersen/subway-web) /
a0044eb @akavlie Formatting changes.
akavlie authored
70 [subway-server](https://github.com/thedjpetersen/subway-server)
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
71 by David Petersen
72 - [web-irc](https://github.com/akavlie/web-irc) by Aaron Kavlie
73
74 Its goals are twofold:
75 1) Become the best web-based IRC client available
76 2) Provide a really easy method of persistent IRC connections, available
77 from any web browser
78
bd36737 @akavlie A bunch of README changes:
akavlie authored
79 The inspiration for Subway was trying to watch a fellow programmer try
80 to explain how to set up screen/irssi to a non-technical person.
81
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
82
002f40a @akavlie Add credits to README.
akavlie authored
83 Credits
84 -------
85
86 Major Subway contributors include:
87
88 - [David Petersen](https://github.com/thedjpetersen), developer
89 - [Aaron Kavlie](https://github.com/akavlie), developer
6158f96 @ericbarch Linkify
ericbarch authored
90 - [Eric Barch](https://github.com/ericbarch), developer
3f8002b @thedjpetersen Update README.md
authored
91 - [HyeonJe Jun](https://github.com/noraesae), developer
002f40a @akavlie Add credits to README.
akavlie authored
92 - [Jamie Soar](http://www.jamiesoarmusic.co.uk/), notification sounds
bd36737 @akavlie A bunch of README changes:
akavlie authored
93 - Yusuke Kamiyamane, some icons
002f40a @akavlie Add credits to README.
akavlie authored
94
e2de5dc Update README.md
David Petersen authored
95 **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**
96
dba9b54 @akavlie Add note about third-party asset licensing.
akavlie authored
97
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
98 License
99 -------
100
dba9b54 @akavlie Add note about third-party asset licensing.
akavlie authored
101 Excepting third-party assets (licensed as specified in their respective files
102 or directories), this project is covered by the MIT License:
103
104
28756ab @akavlie Add a bunch of stuff to the README.
akavlie authored
105 The MIT License (MIT)
106 Copyright (c) 2011 David Petersen
107
108 Permission is hereby granted, free of charge, to any person obtaining a copy of
109 this software and associated documentation files (the "Software"), to deal in
110 the Software without restriction, including without limitation the rights to
111 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
112 of the Software, and to permit persons to whom the Software is furnished to do
113 so, subject to the following conditions:
114
115 The above copyright notice and this permission notice shall be included in all
116 copies or substantial portions of the Software.
117
118 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
119 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
120 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
121 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
122 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
123 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
124 SOFTWARE.
Something went wrong with that request. Please try again.