2016-05-07 22:26:54 +00:00
[](https://avatar.playat.ch:1000/)
2016-02-10 04:30:05 +00:00
[](https://www.npmjs.org/package/thelounge)
[](https://travis-ci.org/thelounge/lounge)
[](https://david-dm.org/thelounge/lounge)
[](https://david-dm.org/thelounge/lounge#info=devDependencies)
2015-09-13 21:15:49 +00:00
2016-02-10 04:30:05 +00:00
# The Lounge
2014-10-01 19:10:14 +00:00
2015-09-13 21:20:05 +00:00
__What is it?__
2016-02-10 04:30:05 +00:00
The Lounge is a web IRC client that you host on your own server.
2014-08-18 12:50:12 +00:00
2016-02-10 07:47:01 +00:00
*This is the official, community-managed fork of @erming 's great initiative, the [Shout ](https://github.com/erming/shout ) project.*
2015-09-13 21:20:05 +00:00
__What features does it have?__
2016-02-10 04:30:05 +00:00
2014-08-18 12:50:12 +00:00
- Multiple user support
- Stays connected even when you close the browser
- Connect from multiple devices at once
- Responsive layout — works well on your smartphone
2014-08-18 12:55:27 +00:00
- _.. and more!_
2014-08-18 12:50:12 +00:00
2016-02-23 19:01:11 +00:00
__Why the fork?__
We felt that the original [Shout ](https://github.com/erming/shout ) project
"stagnated" a little because its original author wanted it to remain his pet
project (which is a perfectly fine thing!).
A bunch of people, excited about doing things a bit differently than the upstream
project forked it under a new name: “The Lounge”.
This fork aims to be community managed, meaning that the decisions are taken
in a collegial fashion, and that a bunch of maintainers should be able to make
the review process quicker and more streamlined.
2014-07-20 23:14:36 +00:00
## Install
2016-04-26 10:51:11 +00:00
To use The Lounge you must have [Node.js ](https://nodejs.org/en/download/ ) installed.
The oldest Node.js version we support is 4.2.0.
If you still use 0.10 or 0.12 we strongly advise you to upgrade before installing The Lounge.
For more information on how to upgrade, read the [documentation ](https://nodejs.org/en/download/package-manager/ ).
2014-08-13 01:27:53 +00:00
```
2016-02-10 04:30:05 +00:00
sudo npm install -g thelounge
2014-08-13 01:27:53 +00:00
```
2014-07-20 23:14:36 +00:00
2014-08-13 01:27:53 +00:00
## Usage
2014-07-20 23:14:36 +00:00
2014-09-30 18:18:31 +00:00
When the install is complete, go ahead and run this in your terminal:
2014-08-19 01:53:17 +00:00
2014-08-17 15:40:28 +00:00
```
2016-02-10 04:30:05 +00:00
lounge --help
2014-08-13 01:27:53 +00:00
```
2014-07-20 23:14:36 +00:00
2016-02-10 04:30:05 +00:00
For more information, read the [documentation ](https://thelounge.github.io/docs/ ).
2014-09-30 18:21:03 +00:00
2015-02-06 11:10:11 +00:00
## Development setup
To run the app from source, just clone the code and run this in your terminal:
```
npm install
2015-11-09 16:11:21 +00:00
npm start
2015-02-06 11:10:11 +00:00
```
2016-02-18 06:01:37 +00:00
You will have to run `npm run build` if you change or add anything in
2016-05-08 09:36:18 +00:00
`client/js/libs` or `client/views` .
2016-02-18 06:01:37 +00:00
2014-07-20 23:14:36 +00:00
## License
2016-04-29 10:42:04 +00:00
Available under the [MIT License ](LICENSE ).
2015-10-06 07:55:30 +00:00
Some fonts licensed under [SIL OFL ](http://scripts.sil.org/OFL ) and the [Apache License ](http://www.apache.org/licenses/ ).
