thelounge/README.md

# The Lounge

Modern web IRC client designed for self-hosting.

[![#thelounge IRC channel on freenode](https://img.shields.io/badge/freenode-%23thelounge-BA68C8.svg)](https://demo.thelounge.chat/)
[![npm version](https://img.shields.io/npm/v/thelounge.svg)](https://www.npmjs.org/package/thelounge)
[![Travis CI Build Status](https://img.shields.io/travis/thelounge/lounge/master.svg?label=linux+build)](https://travis-ci.org/thelounge/lounge)
[![AppVeyor Build Status](https://img.shields.io/appveyor/ci/astorije/lounge/master.svg?label=windows+build)](https://ci.appveyor.com/project/astorije/lounge/branch/master)
[![Dependencies Status](https://img.shields.io/david/thelounge/lounge.svg)](https://david-dm.org/thelounge/lounge)

## Overview

* **Modern features brought to IRC.** Push notifications, link previews, new message markers, and more bring IRC to the 21st century.
* **Always connected.** Remains connected to IRC servers while you are offline.
* **Cross platform.** It doesn't matter what OS you use, it just works wherever Node.js runs.
* **Responsive interface.** The client works smoothly on every desktop, smartphone and tablet.
* **Synchronized experience.** Always resume where you left off no matter what device.

To learn more about configuration, usage and features of The Lounge, take a look at [the website](https://thelounge.github.io).

<p align="center">
	<img src="https://user-images.githubusercontent.com/8675906/28143204-53116e8c-6719-11e7-992b-d1ba442c6c37.png" width="550">
</p>

The Lounge is the official and community-managed fork of [Shout](https://github.com/erming/shout), by [Mattias Erming](https://github.com/erming).

## Installation and usage

The Lounge requires [Node.js](https://nodejs.org/) v4 or more recent.

### Running stable releases from npm (recommended)

Run this in a terminal to install (or upgrade) the latest stable release from
[npm](https://www.npmjs.com/):

```sh
[sudo] npm install -g thelounge
```

When installation is complete, run:

```sh
thelounge start
```

For more information, read the [documentation](https://thelounge.github.io/docs/), [wiki](https://github.com/thelounge/lounge/wiki), or run:

```sh
thelounge --help
```

### Running from source

The following commands install and run the development version of The Lounge:

```sh
git clone https://github.com/thelounge/lounge.git
cd lounge
npm install
NODE_ENV=production npm run build
npm start
```

When installed like this, npm doesn't create a `thelounge` executable. Use `npm start -- <command>` to run subcommands.

⚠️ While it is the most recent codebase, this is not production-ready! Run at
your own risk. It is also not recommended to run this as root.

## 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` or `client/views`
Update the project name Also remove link to the demo and use HTTPS to the docs 2016-02-10 04:30:05 +00:00			`# The Lounge`
Update README.md 2014-10-01 19:10:14 +00:00
Add feature overview in readme 2017-08-16 19:56:38 +00:00			`Modern web IRC client designed for self-hosting.`

Update README badge to new demo URL 2017-07-17 22:17:01 +00:00			`[![#thelounge IRC channel on freenode](https://img.shields.io/badge/freenode-%23thelounge-BA68C8.svg)](https://demo.thelounge.chat/)`
Reduce badge size in readme 2016-10-16 07:11:52 +00:00			`[![npm version](https://img.shields.io/npm/v/thelounge.svg)](https://www.npmjs.org/package/thelounge)`
			`[![Travis CI Build Status](https://img.shields.io/travis/thelounge/lounge/master.svg?label=linux+build)](https://travis-ci.org/thelounge/lounge)`
			`[![AppVeyor Build Status](https://img.shields.io/appveyor/ci/astorije/lounge/master.svg?label=windows+build)](https://ci.appveyor.com/project/astorije/lounge/branch/master)`
			`[![Dependencies Status](https://img.shields.io/david/thelounge/lounge.svg)](https://david-dm.org/thelounge/lounge)`

Add feature overview in readme 2017-08-16 19:56:38 +00:00			`## Overview`

Web Push Notifications 2017-07-10 19:47:03 +00:00			`* Modern features brought to IRC. Push notifications, link previews, new message markers, and more bring IRC to the 21st century.`
Add feature overview in readme 2017-08-16 19:56:38 +00:00			`* Always connected. Remains connected to IRC servers while you are offline.`
			`* Cross platform. It doesn't matter what OS you use, it just works wherever Node.js runs.`
			`* Responsive interface. The client works smoothly on every desktop, smartphone and tablet.`
			`* Synchronized experience. Always resume where you left off no matter what device.`
Update the project name Also remove link to the demo and use HTTPS to the docs 2016-02-10 04:30:05 +00:00
Simplify introduction on README Features listed here are the same as on Shout repo, in same order, participating to the feeling of fork with nothing new. Instead of listing features here, we should refer to the website and improve it to make it as current as possible (there was some recent action there, and more coming, so it is reasonable to point there). Also, this "Why the fork?" section was useful right when we forked, but now it gives unnecessary and lengthy information (it is now the most verbose section of the README!). The Lounge has enough momentum as that point to be treated as its own project. Finally, shortening this section moves the screenshot back up on the page, and mobile view now has more context in the description. 2016-12-11 09:14:17 +00:00			`To learn more about configuration, usage and features of The Lounge, take a look at [the website](https://thelounge.github.io).`
Added a section explaining why a fork was created. 2016-02-23 19:01:11 +00:00
Fix wrong order between screenshot and badges on README Branch was not exactly up-to-date with `master` when merged, and badges were moved below the title in #713, so we missed that at review time. 2016-12-09 05:51:22 +00:00			`<p align="center">`
Update screenshot in README 2017-07-12 22:38:18 +00:00			`<img src="https://user-images.githubusercontent.com/8675906/28143204-53116e8c-6719-11e7-992b-d1ba442c6c37.png" width="550">`
Fix wrong order between screenshot and badges on README Branch was not exactly up-to-date with `master` when merged, and badges were moved below the title in #713, so we missed that at review time. 2016-12-09 05:51:22 +00:00			`</p>`

Simplify introduction on README Features listed here are the same as on Shout repo, in same order, participating to the feeling of fork with nothing new. Instead of listing features here, we should refer to the website and improve it to make it as current as possible (there was some recent action there, and more coming, so it is reasonable to point there). Also, this "Why the fork?" section was useful right when we forked, but now it gives unnecessary and lengthy information (it is now the most verbose section of the README!). The Lounge has enough momentum as that point to be treated as its own project. Finally, shortening this section moves the screenshot back up on the page, and mobile view now has more context in the description. 2016-12-11 09:14:17 +00:00			`The Lounge is the official and community-managed fork of [Shout](https://github.com/erming/shout), by [Mattias Erming](https://github.com/erming).`

Add information on running from source and clean up README a bit 2016-09-20 04:06:54 +00:00			`## Installation and usage`
Update README.md 2014-07-20 23:14:36 +00:00
Add information on running from source and clean up README a bit 2016-09-20 04:06:54 +00:00			`The Lounge requires [Node.js](https://nodejs.org/) v4 or more recent.`
Document supported node version 2016-04-26 10:51:11 +00:00
Add information on running from source and clean up README a bit 2016-09-20 04:06:54 +00:00			`### Running stable releases from npm (recommended)`
Document supported node version 2016-04-26 10:51:11 +00:00
Add information on running from source and clean up README a bit 2016-09-20 04:06:54 +00:00			`Run this in a terminal to install (or upgrade) the latest stable release from`
			`[npm](https://www.npmjs.com/):`
Update README.md 2014-07-20 23:14:36 +00:00
Add information on running from source and clean up README a bit 2016-09-20 04:06:54 +00:00			```sh
			`[sudo] npm install -g thelounge`
			```
Update README.md 2014-07-20 23:14:36 +00:00
Add information on running from source and clean up README a bit 2016-09-20 04:06:54 +00:00			`When installation is complete, run:`
Added 'shout config' command 2014-08-19 01:53:17 +00:00
Add information on running from source and clean up README a bit 2016-09-20 04:06:54 +00:00			```sh
Switch CLI tool from `lounge` to `thelounge` and deprecate `lounge` This is in preparation of The Lounge v3 which will make `thelounge` uniform across the entire project. No more confusion! 2017-11-12 20:49:04 +00:00			`thelounge start`
Update README.md 2014-08-17 15:40:28 +00:00			```
Add information on running from source and clean up README a bit 2016-09-20 04:06:54 +00:00
			`For more information, read the [documentation](https://thelounge.github.io/docs/), [wiki](https://github.com/thelounge/lounge/wiki), or run:`

			```sh
Switch CLI tool from `lounge` to `thelounge` and deprecate `lounge` This is in preparation of The Lounge v3 which will make `thelounge` uniform across the entire project. No more confusion! 2017-11-12 20:49:04 +00:00			`thelounge --help`
Update README.md 2014-08-13 01:27:53 +00:00			```
Update README.md 2014-07-20 23:14:36 +00:00
Add information on running from source and clean up README a bit 2016-09-20 04:06:54 +00:00			`### Running from source`
add development setup instructions, thanks @hennevogel, fix #355 2015-02-06 11:10:11 +00:00
Explain about `lounge` command in dev installations 2017-01-23 04:55:17 +00:00			`The following commands install and run the development version of The Lounge:`
add development setup instructions, thanks @hennevogel, fix #355 2015-02-06 11:10:11 +00:00
Add information on running from source and clean up README a bit 2016-09-20 04:06:54 +00:00			```sh
			`git clone https://github.com/thelounge/lounge.git`
			`cd lounge`
add development setup instructions, thanks @hennevogel, fix #355 2015-02-06 11:10:11 +00:00			`npm install`
Make and document `npm run build` now a mandatory step of the install/build setup This has several reasons, benefits and consequences: - When running on root (which is not recommended anyway), `npm run build` was already necessary. - This allows to not use the `prepublish` hook, whose behavior is going to change in npm v5 and again in npm v6. - This allows to create both production and development builds when running from source. - It makes `npm run build` compatible with Windows again for development environments (lost in previous commit). - It uses the `prepublishOnly` hook added in npm v4. Since this hook is not available prior to that, deployment to npm from Travis has to be done on the Node.js v7 environment. 2017-01-07 23:29:56 +00:00			`NODE_ENV=production npm run build`
fix development setup command, fix #535 2015-11-09 16:11:21 +00:00			`npm start`
add development setup instructions, thanks @hennevogel, fix #355 2015-02-06 11:10:11 +00:00			```

Switch CLI tool from `lounge` to `thelounge` and deprecate `lounge` This is in preparation of The Lounge v3 which will make `thelounge` uniform across the entire project. No more confusion! 2017-11-12 20:49:04 +00:00			When installed like this, npm doesn't create a `thelounge` executable. Use `npm start -- <command>` to run subcommands.
Explain about `lounge` command in dev installations 2017-01-23 04:55:17 +00:00
Make and document `npm run build` now a mandatory step of the install/build setup This has several reasons, benefits and consequences: - When running on root (which is not recommended anyway), `npm run build` was already necessary. - This allows to not use the `prepublish` hook, whose behavior is going to change in npm v5 and again in npm v6. - This allows to create both production and development builds when running from source. - It makes `npm run build` compatible with Windows again for development environments (lost in previous commit). - It uses the `prepublishOnly` hook added in npm v4. Since this hook is not available prior to that, deployment to npm from Travis has to be done on the Node.js v7 environment. 2017-01-07 23:29:56 +00:00			`⚠️ While it is the most recent codebase, this is not production-ready! Run at`
			`your own risk. It is also not recommended to run this as root.`
Warn against running from source as root in README 2016-10-29 00:13:54 +00:00
Add information on running from source and clean up README a bit 2016-09-20 04:06:54 +00: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
Update README directions on when to `npm run build` need to `npm run build` a lot more since webpack was added 2017-07-10 17:05:47 +00:00			- Run `npm run build` if you change or add anything in `client/js` or `client/views`