/lounge

💬 The Lounge — Modern self-hosted web IRC client
  1. JavaScript 79.5%
  2. CSS 12.1%
  3. Smarty 7.3%
  4. Other 1.1%
JavaScript CSS Smarty Other
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP
Find file
Switch branches/tags
Nothing to show
Latest commit 52b3ef1 Jan 5, 2018 @xPaw xPaw Merge pull request #1941 from thelounge/xpaw/fix-log-from 
Fix nicknames in text logs
Permalink
Failed to load latest commit information.
client fix animation jitter when clicking join channel button Jan 4, 2018
defaults Fix incorrect documentation url in default config Dec 22, 2017
scripts Separate and improve wording for `pre` and `rc` pre-release versions Dec 28, 2017
src Fix nicknames in text logs Jan 5, 2018
test Store images with correct file extension Jan 3, 2018
.editorconfig Use stylelint-config-standard Jun 22, 2017
.eslintignore Create public folder with webpack Oct 18, 2017
.eslintrc.yml Enable no-use-before-define rule Dec 6, 2017
.gitattributes Add gitattributes to normalize line endings Jan 24, 2016
.gitignore Create public folder with webpack Oct 18, 2017
.npmignore Deprecate LOUNGE_HOME env var in favor of THELOUNGE_HOME, .lounge_hom… Nov 21, 2017
.npmrc Add .npmrc file; set save-exact to true so packages are installed pin… Jun 29, 2017
.nycrc Ignore coverage folder from coverage report Dec 1, 2017
.stylelintrc.yml Update stylelint rules Nov 26, 2017
.thelounge_home Deprecate LOUNGE_HOME env var in favor of THELOUNGE_HOME, .lounge_hom… Nov 21, 2017
.travis.yml Add Node V9 testing to Travis builds Nov 1, 2017
CHANGELOG.md Add changelog entry for v2.7.0-pre.4 Dec 28, 2017
CONTRIBUTING.md Fix 'help wanted' link Oct 30, 2017
LICENSE Update LICENSE notice to add ours on top of @erming and Shout Feb 10, 2016
README.md Switch CLI tool from `lounge` to `thelounge` and deprecate `lounge` Nov 22, 2017
SUPPORT.md Add a SUPPORT file Aug 1, 2017
appveyor.yml Do not build feature branch with open pull requests on AppVeyor Apr 22, 2017
index.js Enable ESLint `no-console` rule to avoid future mistakes Sep 18, 2017
package.json fix(package): update irc-framework to version 2.10.3 Jan 4, 2018
webpack.config.js Rename the error handlers file at loading time Dec 21, 2017

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.

Running stable releases from npm (recommended)

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