2016-05-07 18:26:54 -04:00
[](https://avatar.playat.ch:1000/)
2016-02-09 23:30:05 -05:00
[](https://www.npmjs.org/package/thelounge)
2016-05-30 19:27:59 -04:00
[](https://travis-ci.org/thelounge/lounge)
[](https://ci.appveyor.com/project/astorije/lounge/branch/master)
2016-02-09 23:30:05 -05:00
[](https://david-dm.org/thelounge/lounge)
[](https://david-dm.org/thelounge/lounge#info=devDependencies)
2015-09-13 17:15:49 -04:00
2016-02-09 23:30:05 -05:00
# The Lounge
2014-10-01 15:10:14 -04:00
2015-09-13 17:20:05 -04:00
__What is it?__
2016-02-09 23:30:05 -05:00
The Lounge is a web IRC client that you host on your own server.
2014-08-18 08:50:12 -04:00
2016-02-10 02:47:01 -05:00
*This is the official, community-managed fork of @erming 's great initiative, the [Shout ](https://github.com/erming/shout ) project.*
2015-09-13 17:20:05 -04:00
__What features does it have?__
2016-02-09 23:30:05 -05:00
2014-08-18 08:50:12 -04: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 08:55:27 -04:00
- _.. and more!_
2014-08-18 08:50:12 -04:00
2016-02-23 14:01:11 -05: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.
2016-09-20 00:06:54 -04:00
## Installation and usage
2014-07-20 19:14:36 -04:00
2016-09-20 00:06:54 -04:00
The Lounge requires [Node.js ](https://nodejs.org/ ) v4 or more recent.
2016-04-26 06:51:11 -04:00
2016-09-20 00:06:54 -04:00
### Running stable releases from npm (recommended)
2016-04-26 06:51:11 -04:00
2016-09-20 00:06:54 -04:00
Run this in a terminal to install (or upgrade) the latest stable release from
[npm ](https://www.npmjs.com/ ):
2014-07-20 19:14:36 -04:00
2016-09-20 00:06:54 -04:00
```sh
[sudo] npm install -g thelounge
```
2014-07-20 19:14:36 -04:00
2016-09-20 00:06:54 -04:00
When installation is complete, run:
2014-08-18 21:53:17 -04:00
2016-09-20 00:06:54 -04:00
```sh
lounge start
2014-08-17 11:40:28 -04:00
```
2016-09-20 00:06:54 -04:00
For more information, read the [documentation ](https://thelounge.github.io/docs/ ), [wiki ](https://github.com/thelounge/lounge/wiki ), or run:
```sh
2016-02-09 23:30:05 -05:00
lounge --help
2014-08-12 21:27:53 -04:00
```
2014-07-20 19:14:36 -04:00
2016-09-20 00:06:54 -04:00
### Running from source
2015-02-06 06:10:11 -05:00
2016-09-20 00:06:54 -04:00
The following commands install the development version of The Lounge. A word of
caution: while it is the most recent codebase, this is not production-ready!
2015-02-06 06:10:11 -05:00
2016-09-20 00:06:54 -04:00
```sh
git clone https://github.com/thelounge/lounge.git
cd lounge
2015-02-06 06:10:11 -05:00
npm install
2015-11-09 11:11:21 -05:00
npm start
2015-02-06 06:10:11 -05:00
```
2016-09-20 00:06:54 -04:00
## Development setup
Simply follow the instructions to run The Lounge from source above, on your own
fork.
Before submitting any change, make sure to:
- Read the [Contributing instructions ](https://github.com/thelounge/lounge/blob/master/CONTRIBUTING.md#contributing )
- Run `npm test` to execute linters and test suite
- Run `npm run build` if you change or add anything in `client/js/libs` or `client/views`
