No Description
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Jérémie Astori 35e13cad62
Merge pull request #2983 from thelounge/astorije/upload-file-casing
7 hours ago
.github Merge pull request #2604 from Zarthus/issue_templates 6 months ago
client Fix casing of "Upload file" tooltip 9 hours ago
defaults Fix spelling mistake in defaults/config.js 1 month ago
scripts List website contributors as well when generating changelog entries 1 week ago
src Don't allow setting values to be objects 2 days ago
test Assert LDAP bind failed error and search warning log messages in ldap tests 1 week ago
.editorconfig Use stylelint-config-standard 1 year ago
.eslintignore Create public folder with webpack 1 year ago
.eslintrc.yml Update `no-confusing-error` eslint rule to allow parenthesis 6 months ago
.gitattributes Add gitattributes to normalize line endings 3 years ago
.gitignore Move .nyc_output folder out of root 7 months ago
.npmignore Replace Greenkeeper with Renovate 8 months ago
.npmrc Set sign-git-tag to true in .npmrc 1 year ago
.stylelintrc.yml Update stylelint rules 1 year ago
.thelounge_home Switch default home location to `~/.thelounge` and remove support of `.lounge_home` 11 months ago
.travis.yml Merge pull request #2877 from thelounge/astorije/node-11 2 months ago
CHANGELOG.md Update changelog 3 days ago
LICENSE Update LICENSE notice to add ours on top of @erming and Shout 2 years ago
README.md Remove wiki link from readme 1 month ago
SECURITY.md Remove mailto: part of security email address 10 months ago
index.js Fix missing colors dependency, simplify version warning 1 month ago
package.json Update dependency irc-framework to v4.1.0 1 day ago
renovate.json Enable rebaseStalePrs in renovate 7 months ago
webpack.config-browser.js Fix `yarn text:browser` not loading any test 9 months ago
webpack.config-test.js Fix stacktraces in client tests 4 months ago
webpack.config.js Remove moment locales from build 4 months ago
yarn.lock Update dependency irc-framework to v4.1.0 1 day ago

README.md

The Lounge

Modern web IRC client designed for self-hosting

WebsiteDocsDemo


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