485fab6cd4
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.
72 lines
2.6 KiB
Markdown
72 lines
2.6 KiB
Markdown
# The Lounge
|
|
|
|
[](https://avatar.playat.ch:1000/)
|
|
[](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)
|
|
[](https://david-dm.org/thelounge/lounge?type=dev)
|
|
|
|
The Lounge is a modern web IRC client designed for self-hosting.
|
|
|
|
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://cloud.githubusercontent.com/assets/5481612/19623041/9bbaec40-9888-11e6-9961-8f3e0493ba30.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
|
|
lounge start
|
|
```
|
|
|
|
For more information, read the [documentation](https://thelounge.github.io/docs/), [wiki](https://github.com/thelounge/lounge/wiki), or run:
|
|
|
|
```sh
|
|
lounge --help
|
|
```
|
|
|
|
### Running from source
|
|
|
|
The following commands install the development version of The Lounge:
|
|
|
|
```sh
|
|
git clone https://github.com/thelounge/lounge.git
|
|
cd lounge
|
|
npm install
|
|
npm start
|
|
```
|
|
|
|
A word of caution:
|
|
|
|
- While it is the most recent codebase, this is not production-ready!
|
|
- It is not recommended to run this as root. However, if you decide to do so,
|
|
you will have to run `npm run build`.
|
|
|
|
## 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`
|