2016-03-17 10:46:29 -04: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-09 23:30:05 -05: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 17:15:49 -04:00
2016-02-09 23:30:05 -05:00
# The Lounge
2014-10-01 15:10:14 -04:00
2015-09-13 17:20:05 -04:00
__What is it?__
2016-02-09 23:30:05 -05:00
The Lounge is a web IRC client that you host on your own server.
2014-08-18 08:50:12 -04:00
2016-02-10 02:47:01 -05:00
*This is the official, community-managed fork of @erming 's great initiative, the [Shout ](https://github.com/erming/shout ) project.*
2015-09-13 17:20:05 -04:00
__What features does it have?__
2016-02-09 23:30:05 -05:00
2014-08-18 08:50:12 -04: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 08:55:27 -04:00
- _.. and more!_
2014-08-18 08:50:12 -04:00
2016-02-23 14:01:11 -05: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-20 19:14:36 -04:00
## Install
2014-08-12 21:27:53 -04:00
```
2016-02-09 23:30:05 -05:00
sudo npm install -g thelounge
2014-08-12 21:27:53 -04:00
```
2014-07-20 19:14:36 -04:00
2014-08-12 21:27:53 -04:00
## Usage
2014-07-20 19:14:36 -04:00
2014-09-30 14:18:31 -04:00
When the install is complete, go ahead and run this in your terminal:
2014-08-18 21:53:17 -04:00
2014-08-17 11:40:28 -04:00
```
2016-02-09 23:30:05 -05:00
lounge --help
2014-08-12 21:27:53 -04:00
```
2014-07-20 19:14:36 -04:00
2016-02-09 23:30:05 -05:00
For more information, read the [documentation ](https://thelounge.github.io/docs/ ).
2014-09-30 14:21:03 -04:00
2015-02-06 06:10:11 -05:00
## Development setup
To run the app from source, just clone the code and run this in your terminal:
```
npm install
2015-11-09 11:11:21 -05:00
npm start
2015-02-06 06:10:11 -05:00
```
2016-02-18 01:01:37 -05:00
You will have to run `npm run build` if you change or add anything in
`client/js/libs` or `client/views.`
2014-07-20 19:14:36 -04:00
## License
2015-10-06 03:55:30 -04: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/ ).