No description
Find a file
Jérémie Astori 7e39ae045f Merge pull request #681 from thelounge/xpaw/more-eslint
Enforce more eslint rules
2016-10-09 19:02:04 -04:00
client Enforce more eslint rules 2016-10-09 17:55:37 -04:00
defaults Enforce strict mode across all JS files with ESLint 2016-10-09 15:14:02 -04:00
scripts Enforce more eslint rules 2016-10-09 17:55:37 -04:00
src Enforce more eslint rules 2016-10-09 17:55:37 -04:00
test Enforce more eslint rules 2016-10-09 17:55:37 -04: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 Enforce more eslint rules 2016-10-09 17:55:37 -04: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 Add OSX testing to travis, cache node_modules 2016-06-13 22:04:33 +03:00
appveyor.yml Do not cache npm-cache folder on appveyor 2016-06-13 22:34:34 +03:00
CHANGELOG.md Add change log entry for upcoming v2.0.1 2016-09-28 00:20:44 -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 2.0.1 2016-09-28 00:21:01 -04:00
README.md Fix devDependency URL in David badge 2016-09-27 01:24:47 -04:00

#thelounge IRC channel on freenode npm version Travis CI Build Status AppVeyor Build status Dependency Status devDependency Status

The Lounge

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. A word of caution: while it is the most recent codebase, this is not production-ready!

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

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