thelounge/README.md

119 lines
4.1 KiB
Markdown
Raw Normal View History

<h1 align="center">
<img
width="300"
alt="The Lounge"
src="client/img/logo-vertical-transparent-bg.svg">
</h1>
2014-10-01 19:10:14 +00:00
<h3 align="center">
Modern web IRC client designed for self-hosting
</h3>
2017-08-16 19:56:38 +00:00
<p align="center">
<strong>
<a href="https://thelounge.chat/">Website</a>
<a href="https://thelounge.chat/docs">Docs</a>
<a href="https://demo.thelounge.chat/">Demo</a>
</strong>
</p>
<p align="center">
<a href="https://demo.thelounge.chat/"><img
alt="#thelounge IRC channel on freenode"
src="https://img.shields.io/badge/freenode-%23thelounge-415364.svg?colorA=ff9e18&style=flat-square"></a>
<br>
<a href="https://yarn.pm/thelounge"><img
alt="npm version"
src="https://img.shields.io/npm/v/thelounge.svg?style=flat-square"></a>
<a href="https://travis-ci.org/thelounge/thelounge"><img
alt="Travis CI Build Status"
src="https://img.shields.io/travis/thelounge/thelounge/master.svg?label=linux&style=flat-square"></a>
<a href="https://ci.appveyor.com/project/astorije/lounge/branch/master"><img
alt="AppVeyor Build Status"
src="https://img.shields.io/appveyor/ci/astorije/lounge/master.svg?label=windows&style=flat-square"></a>
<a href="https://david-dm.org/thelounge/thelounge"><img
alt="Dependencies Status"
src="https://img.shields.io/david/thelounge/thelounge.svg?style=flat-square"></a>
<a href="https://npm-stat.com/charts.html?package=thelounge&from=2016-02-12"><img
alt="Total downloads on npm"
src="https://img.shields.io/npm/dt/thelounge.svg?colorB=007dc7&style=flat-square"></a>
</p>
<p align="center">
<img src="https://user-images.githubusercontent.com/8675906/28143204-53116e8c-6719-11e7-992b-d1ba442c6c37.png" width="550">
</p>
2016-10-16 07:11:52 +00:00
2017-08-16 19:56:38 +00:00
## Overview
2017-07-10 19:47:03 +00:00
* **Modern features brought to IRC.** Push notifications, link previews, new message markers, and more bring IRC to the 21st century.
2017-08-16 19:56:38 +00:00
* **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.chat).
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
2014-07-20 23:14:36 +00:00
2018-02-21 05:57:05 +00:00
The Lounge requires [Node.js](https://nodejs.org/) v6 or more recent.
2018-04-22 18:32:01 +00:00
[Yarn package manager](https://yarnpkg.com/) is also recommended.
If you want to install with npm, `--unsafe-perm` is required for a correct install.
2016-04-26 10:51:11 +00:00
2018-01-19 10:51:06 +00:00
### Running stable releases using Yarn (recommended)
2016-04-26 10:51:11 +00:00
Run this in a terminal to install (or upgrade) the latest stable release from
2018-01-19 10:51:06 +00:00
[npm registry](https://www.npmjs.com/):
2014-07-20 23:14:36 +00:00
```sh
2018-01-19 10:51:06 +00:00
[sudo] yarn global add thelounge
```
If you already have The Lounge installed globally, use the following command to update it:
```sh
[sudo] yarn global upgrade thelounge
```
2014-07-20 23:14:36 +00:00
When installation is complete, run:
2014-08-19 01:53:17 +00:00
```sh
thelounge start
2014-08-17 15:40:28 +00:00
```
For more information, read the [documentation](https://thelounge.chat/docs/), [wiki](https://github.com/thelounge/thelounge/wiki), or run:
```sh
thelounge --help
2014-08-13 01:27:53 +00:00
```
2014-07-20 23:14:36 +00:00
### Running from source
The following commands install and run the development version of The Lounge:
```sh
git clone https://github.com/thelounge/thelounge.git
cd thelounge
2018-01-19 10:51:06 +00:00
yarn install
NODE_ENV=production yarn build
yarn start
```
2018-01-19 10:51:06 +00:00
When installed like this, `thelounge` executable is not created. Use `node index <command>` to run commands.
⚠️ 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/thelounge/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`