thelounge/README.md

[![#thelounge IRC channel on freenode](https://img.shields.io/badge/irc%20channel-%23thelounge%20on%20freenode-blue.svg)](https://avatar.playat.ch:1000/)
[![npm version](https://img.shields.io/npm/v/thelounge.svg)](https://www.npmjs.org/package/thelounge)
[![Travis CI Build Status](https://travis-ci.org/thelounge/lounge.svg?branch=master)](https://travis-ci.org/thelounge/lounge)
[![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/deymtp0lldq78s8t/branch/master?svg=true)](https://ci.appveyor.com/project/astorije/lounge/branch/master)
[![Dependency Status](https://david-dm.org/thelounge/lounge.svg)](https://david-dm.org/thelounge/lounge)
[![devDependency Status](https://david-dm.org/thelounge/lounge/dev-status.svg)](https://david-dm.org/thelounge/lounge#info=devDependencies)

# The Lounge

__What is it?__

The Lounge is a web IRC client that you host on your own server.

*This is the official, community-managed fork of @erming's great initiative, the [Shout](https://github.com/erming/shout) project.*

__What features does it have?__

- Multiple user support
- Stays connected even when you close the browser
- Connect from multiple devices at once
- Responsive layout — works well on your smartphone
- _.. and more!_

__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.

## Install

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/).

```
sudo npm install -g thelounge
```

## Usage

When the install is complete, go ahead and run this in your terminal:

```
lounge --help
```

For more information, read the [documentation](https://thelounge.github.io/docs/).

## Development setup

To run the app from source, just clone the code and run this in your terminal:

```
npm install
npm start
```

You will have to run `npm run build` if you change or add anything in
`client/js/libs` or `client/views`.

## License

Available under the [MIT License](LICENSE).

Some fonts licensed under [SIL OFL](http://scripts.sil.org/OFL) and the [Apache License](http://www.apache.org/licenses/).
Updates demo link to HTTPS 2016-05-07 22:26:54 +00:00			`[![#thelounge IRC channel on freenode](https://img.shields.io/badge/irc%20channel-%23thelounge%20on%20freenode-blue.svg)](https://avatar.playat.ch:1000/)`
Update the project name Also remove link to the demo and use HTTPS to the docs 2016-02-10 04:30:05 +00:00			`[![npm version](https://img.shields.io/npm/v/thelounge.svg)](https://www.npmjs.org/package/thelounge)`
Add an AppVeyor badge on the README 2016-05-30 23:27:59 +00:00			`[![Travis CI Build Status](https://travis-ci.org/thelounge/lounge.svg?branch=master)](https://travis-ci.org/thelounge/lounge)`
			`[![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/deymtp0lldq78s8t/branch/master?svg=true)](https://ci.appveyor.com/project/astorije/lounge/branch/master)`
Update the project name Also remove link to the demo and use HTTPS to the docs 2016-02-10 04:30:05 +00:00			`[![Dependency Status](https://david-dm.org/thelounge/lounge.svg)](https://david-dm.org/thelounge/lounge)`
			`[![devDependency Status](https://david-dm.org/thelounge/lounge/dev-status.svg)](https://david-dm.org/thelounge/lounge#info=devDependencies)`
Switch to SVG version of npm badge in the README 2015-09-13 21:15:49 +00:00
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
Trim trailing whitespaces in README 2015-09-13 21:20:05 +00:00			`__What is it?__`
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 is a web IRC client that you host on your own server.`
Update README.md 2014-08-18 12:50:12 +00:00
Add mention to credit @erming's great work and inheritance from Shout 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.`

Trim trailing whitespaces in README 2015-09-13 21:20:05 +00:00			`__What features does it have?__`
Update the project name Also remove link to the demo and use HTTPS to the docs 2016-02-10 04:30:05 +00:00
Update README.md 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`
Update README.md 2014-08-18 12:55:27 +00:00			`- _.. and more!_`
Update README.md 2014-08-18 12:50:12 +00:00
Added a section explaining why a fork was created. 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.`

Update README.md 2014-07-20 23:14:36 +00:00			`## Install`

Document supported node version 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/).`

Update README.md 2014-08-13 01:27:53 +00:00			```
Update the project name Also remove link to the demo and use HTTPS to the docs 2016-02-10 04:30:05 +00:00			`sudo npm install -g thelounge`
Update README.md 2014-08-13 01:27:53 +00:00			```
Update README.md 2014-07-20 23:14:36 +00:00
Update README.md 2014-08-13 01:27:53 +00:00			`## Usage`
Update README.md 2014-07-20 23:14:36 +00:00
Update README.md 2014-09-30 18:18:31 +00:00			`When the install is complete, go ahead and run this in your terminal:`
Added 'shout config' command 2014-08-19 01:53:17 +00:00
Update README.md 2014-08-17 15:40:28 +00:00			```
Update the project name Also remove link to the demo and use HTTPS to the docs 2016-02-10 04:30:05 +00:00			`lounge --help`
Update README.md 2014-08-13 01:27:53 +00:00			```
Update README.md 2014-07-20 23:14:36 +00:00
Update the project name Also remove link to the demo and use HTTPS to the docs 2016-02-10 04:30:05 +00:00			`For more information, read the [documentation](https://thelounge.github.io/docs/).`
Update README.md 2014-09-30 18:21:03 +00:00
add development setup instructions, thanks @hennevogel, fix #355 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`
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			```

Remove compiled assets and generate them at prepublish time - Remove minified libs and compiled templates - Add a `prepublish` script to build assets, that run on `npm install` and right before publishing See https://docs.npmjs.com/misc/scripts - Include these compiled assets to the `.gitignore` file - Add an empty .npmignore to make sure the compiled assets are not ignored when publishing https://docs.npmjs.com/misc/developers#keeping-files-out-of-your-package - Update the README to reflect changes in development Note that the Travis CI configuration does not need any tweaking because it cleans up all extra and changed files, up to publishing on npm. That is, right before `prepublish` gets run. See https://docs.travis-ci.com/user/deployment/npm#Releasing-build-artifacts 2016-02-18 06:01:37 +00:00			You will have to run `npm run build` if you change or add anything in
Dot is not part of the path 2016-05-08 09:36:18 +00:00			`client/js/libs` or `client/views`.
Remove compiled assets and generate them at prepublish time - Remove minified libs and compiled templates - Add a `prepublish` script to build assets, that run on `npm install` and right before publishing See https://docs.npmjs.com/misc/scripts - Include these compiled assets to the `.gitignore` file - Add an empty .npmignore to make sure the compiled assets are not ignored when publishing https://docs.npmjs.com/misc/developers#keeping-files-out-of-your-package - Update the README to reflect changes in development Note that the Travis CI configuration does not need any tweaking because it cleans up all extra and changed files, up to publishing on npm. That is, right before `prepublish` gets run. See https://docs.travis-ci.com/user/deployment/npm#Releasing-build-artifacts 2016-02-18 06:01:37 +00:00
Update README.md 2014-07-20 23:14:36 +00:00			`## License`

Change license link to point at our license file 2016-04-29 10:42:04 +00:00			`Available under the [MIT License](LICENSE).`
Add font licensing to README.md 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/).`