mirror of
https://github.com/thelounge/thelounge
synced 2024-11-23 20:43:08 +00:00
ae2b27ba5f
This is already on the badge and at the top of the page, on GitHub UI, as well as in 2 places in npm.
83 lines
3 KiB
Markdown
83 lines
3 KiB
Markdown
[](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#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.
|
|
|
|
## 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. A word of
|
|
caution: while it is the most recent codebase, this is not production-ready!
|
|
|
|
```sh
|
|
git clone https://github.com/thelounge/lounge.git
|
|
cd lounge
|
|
npm install
|
|
npm start
|
|
```
|
|
|
|
## 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`
|