Go to file
2017-05-09 18:18:32 -04:00
client
defaults
scripts
src
test
.editorconfig
.eslintignore
.eslintrc.yml
.gitattributes
.gitignore
.npmignore
.nycrc Exclude Webpack config from coverage report 2017-04-19 01:19:11 -04:00
.stylelintrc
.travis.yml Add an extra Travis CI job to make sure production build succeeds and passes tests 2017-01-23 01:15:50 -05:00
appveyor.yml Do not build feature branch with open pull requests on AppVeyor 2017-04-22 16:04:18 +03:00
CHANGELOG.md Add minimal change log entry for v2.3.0-rc.1 2017-05-07 01:22:38 +02:00
CONTRIBUTING.md
index.js
LICENSE
package.json
README.md
webpack.config.js

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