mirror of
https://github.com/thelounge/thelounge
synced 2024-12-18 00:13:07 +00:00
aca23257ed
This is in preparation of The Lounge v3 which will make `thelounge` uniform across the entire project. No more confusion!
78 lines
3 KiB
Markdown
78 lines
3 KiB
Markdown
# The Lounge
|
|
|
|
Modern web IRC client designed for self-hosting.
|
|
|
|
[](https://demo.thelounge.chat/)
|
|
[](https://www.npmjs.org/package/thelounge)
|
|
[](https://travis-ci.org/thelounge/lounge)
|
|
[](https://ci.appveyor.com/project/astorije/lounge/branch/master)
|
|
[](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`
|