mirror of https://github.com/thelounge/thelounge synced 2024-11-26 14:00:21 +00:00

No description

Find a file

greenkeeper[bot] f9de811df1 chore(package): update handlebars-loader to version 1.5.0 https://greenkeeper.io/		2017-04-21 03:48:20 +00:00
client	Merge pull request #1051 from thelounge/astorije/irc-colors-https	2017-04-20 16:09:50 +03:00
defaults	Add CA bundle option in SSL	2017-04-15 19:12:21 +03:00
scripts	Fix `run_pr.sh` script	2017-02-12 17:33:46 -05:00
src	Merge pull request #1018 from swordbeta/sort_channel_list	2017-04-20 01:40:14 -04:00
test	Store channel keys	2017-04-01 15:28:38 -04:00
.editorconfig	Add .editorconfig	2015-10-26 03:03:12 +01:00
.eslintignore	Webpack	2016-12-27 19:15:30 +02:00
.eslintrc.yml	Setup ESLint to make sure an EOF feed is always present	2017-03-29 00:05:28 -04:00
.gitattributes	Add gitattributes to normalize line endings	2016-01-24 16:12:08 +02:00
.gitignore	Switch istanbul CLI to more recent nyc one	2016-12-29 02:51:26 -05:00
.npmignore	Add nyc and Webpack config files to the files ignored when releasing	2017-01-31 21:20:35 -05:00
.nycrc	Exclude Webpack config from coverage report	2017-04-19 01:19:11 -04:00
.stylelintrc	Update deprecated options and rules	2017-02-02 19:13:05 -05:00
.travis.yml	Add an extra Travis CI job to make sure production build succeeds and passes tests	2017-01-23 01:15:50 -05:00
appveyor.yml	Make and document `npm run build` now a mandatory step of the install/build setup	2017-01-23 01:15:50 -05:00
CHANGELOG.md	Add changelog entry for v2.2.2	2017-03-13 01:27:57 -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	chore(package): update handlebars-loader to version 1.5.0	2017-04-21 03:48:20 +00:00
README.md	Explain about `lounge` command in dev installations	2017-01-24 01:04:40 -08:00
webpack.config.js	Merge pull request #973 from thelounge/xpaw/use-require	2017-03-31 01:41:29 -04:00

README.md

The Lounge

The Lounge is a modern web IRC client designed for self-hosting.

To learn more about configuration, usage and features of The Lounge, take a look at the website.

The Lounge is the official and community-managed fork of Shout, by Mattias Erming.

Installation and usage

The Lounge requires Node.js v4 or more recent.

Running stable releases from npm (recommended)

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 and run the development version of The Lounge:

git clone https://github.com/thelounge/lounge.git
cd lounge
npm install
NODE_ENV=production npm run build
npm start

When installed like this, npm doesn't create a lounge executable. Use npm start -- <command> to run subcommands.

⚠️ While it is the most recent codebase, this is not production-ready! Run at your own risk. It is also not recommended to run this as root.

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