thelounge/README.md
2016-02-27 17:56:24 +01:00

2.2 KiB

#thelounge IRC channel on freenode npm version 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

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.

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.