Hard Lounge - IRCv5 Compliant Webchat Client https://webchat.supernets.org
Go to file
Jérémie Astori 6547d18e7f
Color all references to deprecations in bold red
2017-12-11 23:48:52 -05:00
client Add whois and conversation as action to user contextmenu 2017-12-11 23:04:29 -05:00
defaults
scripts
src Color all references to deprecations in bold red 2017-12-11 23:48:52 -05:00
test Add a `--config` / `-c` option to the `start` CLI command to arbitrarily override any configuration key 2017-12-11 23:48:52 -05:00
.editorconfig
.eslintignore
.eslintrc.yml Enable no-use-before-define rule 2017-12-06 15:57:04 +02:00
.gitattributes
.gitignore
.npmignore
.npmrc
.nycrc Ignore coverage folder from coverage report 2017-11-30 20:33:23 -05:00
.stylelintrc.yml
.thelounge_home
.travis.yml
CHANGELOG.md Add changelog entry for v2.7.0-pre.2 2017-12-01 22:50:17 -05:00
CONTRIBUTING.md
LICENSE
README.md
SUPPORT.md
appveyor.yml
index.js
package.json Merge pull request #1828 from thelounge/greenkeeper/eslint-4.13.1 2017-12-11 23:24:25 -05:00
webpack.config.js

README.md

The Lounge

Modern web IRC client designed for self-hosting.

#thelounge IRC channel on freenode npm version Travis CI Build Status AppVeyor Build Status Dependencies Status

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.

The Lounge is the official and community-managed fork of Shout, by Mattias Erming.

Installation and usage

The Lounge requires Node.js v4 or more recent.

Run this in a terminal to install (or upgrade) the latest stable release from npm:

[sudo] npm install -g thelounge

When installation is complete, run:

thelounge start

For more information, read the documentation, wiki, or run:

thelounge --help

Running from source

The following commands install and run the development version of The Lounge:

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
  • 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