Skip to content
Newer
Older
100644 92 lines (60 sloc) 2.96 KB
60d631f @thedjpetersen Add README to new project
authored Aug 11, 2014
1 Subway
2 ======
3
be6985a @astorije Suggest The Lounge instead of Shout
astorije authored Apr 29, 2016
4 *Subway is not currently functional and not under active development. While the plan is to finish this project some point in the future, currently the maintainer strongly suggests taking a look at [The Lounge](https://github.com/thelounge/lounge).*
aa7a3d1 @thedjpetersen Update README.md
authored Jan 3, 2015
5
60d631f @thedjpetersen Add README to new project
authored Aug 12, 2014
6 Subway is a web-based IRC client with a multi-user backend and a
7 JavaScript-heavy UI. Frontend/backend communication is done with
8 websockets (or best available fallback where not available).
9 The backend supports connection persistence and optional logging when the
10 browser disconnects.
11
12 Subway is built with [node.js](http://nodejs.org/),
13 [node-irc](https://github.com/martynsmith/node-irc)
14 and [Backbone.js](http://documentcloud.github.com/backbone/)/ReactJS and
15 [jQuery](http://jquery.com/) on the frontend.
16
17 Screenshots
18 ------------
19
20 ![Chat](http://i.imgur.com/y56tLP9.png)
21 ![Settings](http://i.imgur.com/hgwRzHq.png)
22
23 Installation
24 ------------
25
26 *Should be something like this, once implemented:*
27
28 1. Assuming you already have node.js, and npm, run:
29
30 $ git clone https://github.com/thedjpetersen/subway.git
31 $ cd subway
32
33 2. Install the dependencies using npm:
34
35 $ npm install
36
37 3. Launch the web server
38
d5a8a6c @vinnymac Fix launching instructions
vinnymac authored Oct 8, 2014
39 $ ./subway.js
60d631f @thedjpetersen Add README to new project
authored Aug 12, 2014
40
41 4. Point your browser at `http://localhost:3000/`
42
43
44 Development
45 -----------
46
47 Discussion about the client takes place on this repository's [Issues](https://github.com/thedjpetersen/subway/issues) page.
48 Contributors are welcome and greatly appreciated.
49
50
af982cd @thedjpetersen Update README.md
authored Aug 19, 2014
51 Goals
60d631f @thedjpetersen Add README to new project
authored Aug 12, 2014
52 -------
53
54 Its goals are twofold:
af982cd @thedjpetersen Update README.md
authored Aug 19, 2014
55
60d631f @thedjpetersen Add README to new project
authored Aug 12, 2014
56 1) Become the best web-based IRC client available
af982cd @thedjpetersen Update README.md
authored Aug 19, 2014
57
60d631f @thedjpetersen Add README to new project
authored Aug 12, 2014
58 2) Provide a really easy method of persistent IRC connections, available
59 from any web browser
60
61 The inspiration for Subway was trying to watch a fellow programmer try
62 to explain how to set up screen/irssi to a non-technical person.
63
64
65 License
66 -------
67
68 Excepting third-party assets (licensed as specified in their respective files
69 or directories), this project is covered by the MIT License:
70
71
72 The MIT License (MIT)
aa7a3d1 @thedjpetersen Update README.md
authored Jan 3, 2015
73 Copyright (c) 2015 David Petersen
60d631f @thedjpetersen Add README to new project
authored Aug 12, 2014
74
75 Permission is hereby granted, free of charge, to any person obtaining a copy of
76 this software and associated documentation files (the "Software"), to deal in
77 the Software without restriction, including without limitation the rights to
78 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
79 of the Software, and to permit persons to whom the Software is furnished to do
80 so, subject to the following conditions:
81
82 The above copyright notice and this permission notice shall be included in all
83 copies or substantial portions of the Software.
84
85 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
86 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
87 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
88 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
89 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
90 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
91 SOFTWARE.
Something went wrong with that request. Please try again.