No description
Find a file
Jérémie Astori 559281bfb9
Merge pull request #2076 from thelounge/xpaw/no-scripts-coverage
Skip scripts folder from test coverage
2018-02-19 11:43:12 -05:00
client Merge pull request #2059 from thelounge/xpaw/motd 2018-02-19 18:42:16 +02:00
defaults Fix incorrect documentation url in default config 2017-12-22 10:16:09 +01:00
scripts Use some ES6/Node v4-only syntax when possible 2018-02-19 18:30:00 +02:00
src Merge pull request #2059 from thelounge/xpaw/motd 2018-02-19 18:42:16 +02:00
test Merge pull request #2059 from thelounge/xpaw/motd 2018-02-19 18:42:16 +02:00
.editorconfig Use stylelint-config-standard 2017-06-22 11:23:50 +03:00
.eslintignore Create public folder with webpack 2017-10-18 21:20:12 +03:00
.eslintrc.yml Add ES6-related ESLint rules 2018-02-19 18:30:00 +02:00
.gitattributes Add gitattributes to normalize line endings 2016-01-24 16:12:08 +02:00
.gitignore Create public folder with webpack 2017-10-18 21:20:12 +03:00
.npmignore Do not statically serve the index template prior to rendering it 2018-01-14 13:02:27 -05:00
.npmrc Set sign-git-tag to true in .npmrc 2018-01-11 17:12:04 +02:00
.nycrc Skip scripts folder from test coverage 2018-02-19 16:38:21 +02:00
.stylelintrc.yml Update stylelint rules 2017-11-26 14:28:33 +02:00
.thelounge_home Deprecate LOUNGE_HOME env var in favor of THELOUNGE_HOME, .lounge_home file in favor of .thelounge_home 2017-11-21 00:36:26 -05:00
.travis.yml Switch to Node v6 as the oldest version we support 2018-02-19 18:30:00 +02:00
appveyor.yml Switch to Node v6 as the oldest version we support 2018-02-19 18:30:00 +02:00
CHANGELOG.md Add changelog entry for v2.7.1 2018-02-18 15:23:44 -05:00
CONTRIBUTING.md Add SECURITY guidelines about security vulnerability disclosures, and link them from the CONTRIBUTING guidelines 2018-01-15 20:26:26 -05:00
index.js Exit the program when the Node.js version is incompatible with The Lounge 2018-02-19 18:30:00 +02:00
LICENSE Update LICENSE notice to add ours on top of @erming and Shout 2016-02-10 06:20:05 +00:00
package.json Switch to Node v6 as the oldest version we support 2018-02-19 18:30:00 +02:00
README.md Switch CLI tool from lounge to thelounge and deprecate lounge 2017-11-22 16:37:26 -05:00
SECURITY.md Add SECURITY guidelines about security vulnerability disclosures, and link them from the CONTRIBUTING guidelines 2018-01-15 20:26:26 -05:00
SUPPORT.md Add a SUPPORT file 2017-08-01 01:41:49 -04:00
webpack.config.js Use some ES6/Node v4-only syntax when possible 2018-02-19 18:30:00 +02:00

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