No description
Find a file
2016-12-11 03:30:19 -05:00
client Sync reordering of channels/networks to other clients 2016-12-09 14:56:19 +02:00
defaults Remove autoload option and always autoload users 2016-12-11 03:29:30 -05:00
scripts Enforce more eslint rules 2016-10-09 17:55:37 -04:00
src Improve message and style of loading/unloading console logs, use ES6 template literals 2016-12-11 03:30:19 -05:00
test Merge pull request #749 from thelounge/xpaw/hexip 2016-12-10 19:50:33 -05:00
.editorconfig Add .editorconfig 2015-10-26 03:03:12 +01:00
.eslintignore Add code coverage 2016-06-19 13:07:42 -04:00
.eslintrc.yml Update depdencides to latest stable versions 2016-11-19 10:49:16 +02:00
.gitattributes Add gitattributes to normalize line endings 2016-01-24 16:12:08 +02:00
.gitignore Ignore unnecessary files at release time 2016-07-13 23:57:56 -04:00
.istanbul.yml Add code coverage 2016-06-19 13:07:42 -04:00
.npmignore Ignore unnecessary files at release time 2016-07-13 23:57:56 -04:00
.stylelintrc Update developer dependencies 2016-09-25 14:53:03 +03:00
.travis.yml Get rid of OSX CI builds until they get much faster 2016-10-20 01:40:20 -04:00
appveyor.yml Invalidate cache and use appveyor-retry with npm 2016-11-25 19:43:24 -08:00
CHANGELOG.md Add change log entry for upcoming v2.1.0 2016-10-17 00:49:48 -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 #746 from thelounge/xpaw/update-deps 2016-11-20 14:46:16 -05:00
README.md Merge pull request #694 from MaxLeiter/MaxLeiter-image 2016-12-09 00:44:27 -05:00

The Lounge

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

What is it?

The Lounge is a web IRC client that you host on your own server.

This is the official, community-managed fork of @erming's great initiative, the Shout project.

What features does it have?

  • Multiple user support
  • Stays connected even when you close the browser
  • Connect from multiple devices at once
  • Responsive layout — works well on your smartphone
  • .. and more!

Why the fork?

We felt that the original Shout project "stagnated" a little because its original author wanted it to remain his pet project (which is a perfectly fine thing!).

A bunch of people, excited about doing things a bit differently than the upstream project forked it under a new name: “The Lounge”.

This fork aims to be community managed, meaning that the decisions are taken in a collegial fashion, and that a bunch of maintainers should be able to make the review process quicker and more streamlined.

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 the development version of The Lounge:

git clone https://github.com/thelounge/lounge.git
cd lounge
npm install
npm start

A word of caution:

  • While it is the most recent codebase, this is not production-ready!
  • It is not recommended to run this as root. However, if you decide to do so, you will have to run npm run build.

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