2016-03-17 15:46:29 +01:00
[![#thelounge IRC channel on freenode ](https://img.shields.io/badge/irc%20channel-%23thelounge%20on%20freenode-blue.svg )](http://avatar.playat.ch:1000/)
2016-02-10 05:30:05 +01:00
[![npm version ](https://img.shields.io/npm/v/thelounge.svg )](https://www.npmjs.org/package/thelounge)
[![Build Status ](https://travis-ci.org/thelounge/lounge.svg?branch=master )](https://travis-ci.org/thelounge/lounge)
[![Dependency Status ](https://david-dm.org/thelounge/lounge.svg )](https://david-dm.org/thelounge/lounge)
[![devDependency Status ](https://david-dm.org/thelounge/lounge/dev-status.svg )](https://david-dm.org/thelounge/lounge#info=devDependencies)
2015-09-13 23:15:49 +02:00
2016-02-10 05:30:05 +01:00
# The Lounge
2014-10-01 21:10:14 +02:00
2015-09-13 23:20:05 +02:00
__What is it?__
2016-02-10 05:30:05 +01:00
The Lounge is a web IRC client that you host on your own server.
2014-08-18 14:50:12 +02:00
2016-02-10 08:47:01 +01:00
*This is the official, community-managed fork of @erming 's great initiative, the [Shout ](https://github.com/erming/shout ) project.*
2015-09-13 23:20:05 +02:00
__What features does it have?__
2016-02-10 05:30:05 +01:00
2014-08-18 14:50:12 +02:00
- Multiple user support
- Stays connected even when you close the browser
- Connect from multiple devices at once
- Responsive layout — works well on your smartphone
2014-08-18 14:55:27 +02:00
- _.. and more!_
2014-08-18 14:50:12 +02:00
2016-02-23 20:01:11 +01:00
__Why the fork?__
We felt that the original [Shout ](https://github.com/erming/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.
2014-07-21 01:14:36 +02:00
## Install
2014-08-13 03:27:53 +02:00
```
2016-02-10 05:30:05 +01:00
sudo npm install -g thelounge
2014-08-13 03:27:53 +02:00
```
2014-07-21 01:14:36 +02:00
2014-08-13 03:27:53 +02:00
## Usage
2014-07-21 01:14:36 +02:00
2014-09-30 20:18:31 +02:00
When the install is complete, go ahead and run this in your terminal:
2014-08-19 03:53:17 +02:00
2014-08-17 17:40:28 +02:00
```
2016-02-10 05:30:05 +01:00
lounge --help
2014-08-13 03:27:53 +02:00
```
2014-07-21 01:14:36 +02:00
2016-02-10 05:30:05 +01:00
For more information, read the [documentation ](https://thelounge.github.io/docs/ ).
2014-09-30 20:21:03 +02:00
2015-02-06 12:10:11 +01:00
## Development setup
To run the app from source, just clone the code and run this in your terminal:
```
npm install
2015-11-09 17:11:21 +01:00
npm start
2015-02-06 12:10:11 +01:00
```
2016-02-18 07:01:37 +01:00
You will have to run `npm run build` if you change or add anything in
`client/js/libs` or `client/views.`
2014-07-21 01:14:36 +02:00
## License
2015-10-06 09:55:30 +02:00
Available under the [MIT License ](http://mths.be/mit ).
Some fonts licensed under [SIL OFL ](http://scripts.sil.org/OFL ) and the [Apache License ](http://www.apache.org/licenses/ ).