💬 Modern, responsive, cross-platform, self-hosted web IRC client
Branch: master
Clone or download
astorije Merge pull request #3065 from thelounge/renovate/webpack-4.x
Update dependency webpack to v4.29.5
Latest commit 0a1d67b Feb 18, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Merge pull request #2604 from Zarthus/issue_templates Jul 7, 2018
client Merge pull request #3063 from thelounge/astorije/scroll-down-btn-ui Feb 18, 2019
defaults Add `webirc` key and commas to make it more understandable Jan 30, 2019
scripts Merge pull request #3004 from thelounge/xpaw/drop-node-6 Feb 12, 2019
src Set moreHistoryAvailable when history reloads from storage Feb 13, 2019
test Instrument tests with nyc instead of istanbul-instrumenter-loader. Feb 12, 2019
.editorconfig Use a default of 4 spaces for viewing purposes Feb 3, 2019
.eslintignore Create public folder with webpack Oct 18, 2017
.eslintrc.yml Update Vue packages Feb 13, 2019
.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 Change build priority order in Travis Feb 16, 2019
CHANGELOG.md Add changelog entry for v3.0.1 Feb 11, 2019
LICENSE Update LICENSE notice to add ours on top of @erming and Shout Feb 10, 2016
README.md Remove wiki link from readme Nov 21, 2018
SECURITY.md Remove mailto: part of security email address Mar 12, 2018
index.js Fix missing colors dependency, simplify version warning Nov 27, 2018
package.json Merge pull request #3065 from thelounge/renovate/webpack-4.x Feb 18, 2019
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 Instrument tests with nyc instead of istanbul-instrumenter-loader. Feb 12, 2019
webpack.config.js Enable `preserveWhitespace: false`, add spaces where needed, fix whit… Feb 12, 2019
yarn.lock Merge pull request #3065 from thelounge/renovate/webpack-4.x Feb 18, 2019

README.md

The Lounge

Modern web IRC client designed for self-hosting

WebsiteDocsDemo

#thelounge IRC channel on freenode
npm version Travis CI 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 usage documentation 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 yarn test to execute linters and test suite
  • Run yarn build if you change or add anything in client/js or client/views
  • yarn dev can be used to start The Lounge and watch for any file changes in the client folder