2016-02-10 04:30:05 +00:00
# The Lounge
2014-10-01 19:10:14 +00:00
2017-08-16 19:56:38 +00:00
Modern web IRC client designed for self-hosting.
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/)
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)
2017-08-16 19:56:38 +00:00
## Overview
* **Modern features brought to IRC.** Link previews, new message markers, ~~push notifications~~ [*(soon!)* ](https://github.com/thelounge/lounge/pull/1124 ), 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.
2016-02-10 04:30:05 +00:00
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 ).
2016-02-23 19:01:11 +00:00
2016-12-09 05:51:22 +00:00
< p align = "center" >
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" >
2016-12-09 05:51:22 +00:00
< / p >
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 ).
2016-09-20 04:06:54 +00:00
## Installation and usage
2014-07-20 23:14:36 +00:00
2016-09-20 04:06:54 +00:00
The Lounge requires [Node.js ](https://nodejs.org/ ) v4 or more recent.
2016-04-26 10:51:11 +00:00
2016-09-20 04:06:54 +00:00
### Running stable releases from npm (recommended)
2016-04-26 10:51:11 +00:00
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/ ):
2014-07-20 23:14:36 +00:00
2016-09-20 04:06:54 +00:00
```sh
[sudo] npm install -g thelounge
```
2014-07-20 23:14:36 +00:00
2016-09-20 04:06:54 +00:00
When installation is complete, run:
2014-08-19 01:53:17 +00:00
2016-09-20 04:06:54 +00:00
```sh
lounge start
2014-08-17 15:40:28 +00:00
```
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
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-09-20 04:06:54 +00:00
### Running from source
2015-02-06 11:10:11 +00:00
2017-01-23 04:55:17 +00:00
The following commands install and run the development version of The Lounge:
2015-02-06 11:10:11 +00:00
2016-09-20 04:06:54 +00:00
```sh
git clone https://github.com/thelounge/lounge.git
cd lounge
2015-02-06 11:10:11 +00:00
npm install
2017-01-07 23:29:56 +00:00
NODE_ENV=production npm run build
2015-11-09 16:11:21 +00:00
npm start
2015-02-06 11:10:11 +00:00
```
2017-01-23 04:55:17 +00:00
When installed like this, npm doesn't create a `lounge` executable. Use `npm start -- <command>` to run subcommands.
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.
2016-10-29 00:13:54 +00:00
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
2017-07-10 17:05:47 +00:00
- Run `npm run build` if you change or add anything in `client/js` or `client/views`