mirror of https://github.com/thelounge/thelounge synced 2024-11-15 08:47:16 +00:00

No description

Find a file

Jérémie Astori 5e7a7a3870 Update CLI help with regard to recent deprecation of `--home` option - Mark the option as deprecated (cannot be removed from the help, unfortunately) - Add details to `lounge config` regarding `LOUNGE_HOME` - Remove mention of `--home` in default config file		2017-08-16 00:33:33 -04:00
client	Do not throw an exception when URI parsing fails	2017-08-14 15:25:34 +03:00
defaults	Update CLI help with regard to recent deprecation of `--home` option	2017-08-16 00:33:33 -04:00
scripts	Do not hardcoded vendor bundles in webpack	2017-06-27 12:55:12 +03:00
src	Update CLI help with regard to recent deprecation of `--home` option	2017-08-16 00:33:33 -04:00
test	Resolve relative URIs in link previewer	2017-08-13 13:06:01 +03:00
.editorconfig	Use stylelint-config-standard	2017-06-22 11:23:50 +03:00
.eslintignore	Webpack	2016-12-27 19:15:30 +02:00
.eslintrc.yml	Update to eslint 4 and enforce extra rules	2017-06-19 09:58:29 +03:00
.gitattributes	Add gitattributes to normalize line endings	2016-01-24 16:12:08 +02:00
.gitignore	Store preview images on disk for privacy, security and caching	2017-07-18 11:37:16 +03:00
.lounge_config	Use .lounge_config to help distribution packages handle config paths right	2017-08-15 21:57:47 +03:00
.npmignore	Ignore all dotfiles in npmignore	2017-06-29 12:49:07 +03:00
.npmrc	Add .npmrc file; set save-exact to true so packages are installed pinned by default	2017-06-28 21:06:23 -07:00
.nycrc	Exclude Webpack config from coverage report	2017-04-19 01:19:11 -04:00
.stylelintrc.yml	Use stylelint-config-standard	2017-06-22 11:23:50 +03:00
.travis.yml	Update node versions for travis	2017-05-31 09:49:39 +01:00
appveyor.yml	Do not build feature branch with open pull requests on AppVeyor	2017-04-22 16:04:18 +03:00
CHANGELOG.md	Add changelog entry for v2.4.0	2017-07-30 18:49:49 -04:00
CONTRIBUTING.md	Add a SUPPORT file	2017-08-01 01:41:49 -04: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 webpack to version 3.5.4	2017-08-12 09:38:21 +00:00
README.md	Merge pull request #1319 from MaxLeiter/patch-1	2017-07-20 08:56:26 +01:00
SUPPORT.md	Add a SUPPORT file	2017-08-01 01:41:49 -04:00
webpack.config.js	Do not hardcoded vendor bundles in webpack	2017-06-27 12:55:12 +03: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 or client/views