thelounge/README.md
2016-08-26 09:16:01 -07:00

2.8 KiB

#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.

Install

To use The Lounge you must have Node.js installed. The oldest Node.js version we support is 4.2.0.

If you still use 0.10 or 0.12 we strongly advise you to upgrade before installing The Lounge. For more information on how to upgrade, read the documentation.

sudo npm install -g thelounge

Usage

When the install is complete, go ahead and run this in your terminal:

lounge --help

For more information, read the documentation or wiki.

Development setup

To run the app from source, just clone the code and run this in your terminal:

npm install
npm start

You will have to run npm run build if you change or add anything in client/js/libs or client/views.

License

Available under the MIT License.

Some fonts licensed under SIL OFL and the Apache License.