JavaScript CSS Smarty
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github Merge pull request #2604 from Zarthus/issue_templates Jul 7, 2018
client Merge pull request #2601 from thelounge/xpaw/fix-2572 Aug 17, 2018
defaults Re-order and improve inline comments of config.js Jul 18, 2018
scripts Merge pull request #2645 from thelounge/astorije/better-docs Jul 21, 2018
src Pass network name along to the client connect window when network is … Aug 11, 2018
test refactor getHumanDate() to accept a timestamp; fixes test Jul 22, 2018
.editorconfig Use stylelint-config-standard Jun 22, 2017
.eslintignore Create public folder with webpack Oct 18, 2017
.eslintrc.yml Update `no-confusing-error` eslint rule to allow parenthesis Jun 26, 2018
.gitattributes Add gitattributes to normalize line endings Jan 24, 2016
.gitignore Move .nyc_output folder out of root Jun 16, 2018
.npmignore Replace Greenkeeper with Renovate May 15, 2018
.npmrc Set sign-git-tag to true in .npmrc Jan 11, 2018
.stylelintrc.yml Update stylelint rules Nov 26, 2017
.thelounge_home Switch default home location to `~/.thelounge` and remove support of … Feb 19, 2018
.travis.yml Pass --frozen-lockfile to yarn in Travis builds May 24, 2018
CHANGELOG.md Add changelog entry for v3.0.0-pre.7 Jun 19, 2018
LICENSE Update LICENSE notice to add ours on top of @erming and Shout Feb 10, 2016
README.md Remove [sudo] for Yarn install/upgrade command in README.md Jul 19, 2018
SECURITY.md Remove mailto: part of security email address Mar 12, 2018
appveyor.yml Instrument client code before running tests Feb 20, 2018
index.js Auto-fix code for padding-line-between-statements rule Feb 20, 2018
package.json fix(deps): update dependency request to v2.88.0 Aug 10, 2018
renovate.json Enable rebaseStalePrs in renovate May 24, 2018
webpack.config-browser.js Fix `yarn text:browser` not loading any test Apr 6, 2018
webpack.config-test.js Update to webpack4 WIP Apr 6, 2018
webpack.config.js Target more modern browsers in babel Jun 16, 2018
yarn.lock fix(deps): update dependency request to v2.88.0 Aug 10, 2018

README.md

The Lounge

Modern web IRC client designed for self-hosting

WebsiteDocsDemo

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

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 v6 or more recent. Yarn package manager is also recommended.
If you want to install with npm, --unsafe-perm is required for a correct install.

Running stable releases using Yarn (recommended)

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

yarn global add thelounge

If you already have The Lounge installed globally, use the following command to update it:

yarn global upgrade 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/thelounge.git
cd thelounge
yarn install
NODE_ENV=production yarn build
yarn start

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