No description
Find a file
Jérémie Astori 0239fdd2fb Merge pull request #1255 from thelounge/xPaw/og-description
Check og:description before description
2017-06-26 01:44:54 -04:00
client Merge pull request #1217 from MaxLeiter/patch-3 2017-06-24 12:19:14 +03:00
defaults Remove kilobyte ambiguity 2017-06-21 14:01:47 +03:00
scripts Always rebase with master when running PRs to make sure latest code is being tested 2017-06-20 01:18:30 -04:00
src Merge pull request #1255 from thelounge/xPaw/og-description 2017-06-26 01:44:54 -04:00
test Update to eslint 4 and enforce extra rules 2017-06-19 09:58:29 +03:00
.editorconfig Use stylelint-config-standard 2017-06-22 11:23:50 +03:00
.eslintignore Webpack 2016-12-27 19:15:30 +02:00
.eslintrc.yml Update to eslint 4 and enforce extra rules 2017-06-19 09:58:29 +03:00
.gitattributes Add gitattributes to normalize line endings 2016-01-24 16:12:08 +02:00
.gitignore Ignore package-lock.json 2017-06-21 10:57:06 +03:00
.npmignore Add nyc and Webpack config files to the files ignored when releasing 2017-01-31 21:20:35 -05:00
.nycrc Exclude Webpack config from coverage report 2017-04-19 01:19:11 -04:00
.stylelintrc.yml Use stylelint-config-standard 2017-06-22 11:23:50 +03:00
.travis.yml Update node versions for travis 2017-05-31 09:49:39 +01:00
appveyor.yml Do not build feature branch with open pull requests on AppVeyor 2017-04-22 16:04:18 +03:00
CHANGELOG.md Remove mention in CHANGELOG that The Lounge uses Semantic Versioning 2017-06-25 01:19:15 -04:00
CONTRIBUTING.md Simplify a great deal the CONTRIBUTING file 2016-02-14 20:09:40 +00:00
index.js Enforce strict mode across all JS files with ESLint 2016-10-09 15:14:02 -04:00
LICENSE Update LICENSE notice to add ours on top of @erming and Shout 2016-02-10 06:20:05 +00:00
package.json Merge pull request #1264 from thelounge/greenkeeper/eslint-4.1.0 2017-06-25 01:29:50 -04:00
README.md Explain about lounge command in dev installations 2017-01-24 01:04:40 -08:00
webpack.config.js Update to eslint 4 and enforce extra rules 2017-06-19 09:58:29 +03:00

The Lounge

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

The Lounge is a modern web IRC client designed for self-hosting.

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:

lounge start

For more information, read the documentation, wiki, or run:

lounge --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 lounge 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/libs or client/views