mirror of https://github.com/thelounge/thelounge synced 2024-11-15 00:37:13 +00:00

No description

Find a file

Jérémie Astori c8418a638d Merge pull request #2058 from thelounge/xpaw/channel-state Track channel state to allow removing channels user is not in		2018-02-17 19:27:09 -05:00
client	Display password field when displayNetwork is false	2018-02-17 10:23:01 +02:00
defaults	Fix incorrect documentation url in default config	2017-12-22 10:16:09 +01:00
scripts	Slightly improve the changelog script, by splitting uncategorized items	2018-01-27 16:32:47 -05:00
src	Merge pull request #2058 from thelounge/xpaw/channel-state	2018-02-17 19:27:09 -05:00
test	Track channel state to allow removing channels user is not in	2018-02-13 12:30:26 +02:00
.editorconfig	Use stylelint-config-standard	2017-06-22 11:23:50 +03:00
.eslintignore	Create public folder with webpack	2017-10-18 21:20:12 +03:00
.eslintrc.yml	Enable no-use-before-define rule	2017-12-06 15:57:04 +02:00
.gitattributes	Add gitattributes to normalize line endings	2016-01-24 16:12:08 +02:00
.gitignore	Create public folder with webpack	2017-10-18 21:20:12 +03:00
.npmignore	Do not statically serve the index template prior to rendering it	2018-01-14 13:02:27 -05:00
.npmrc	Set sign-git-tag to true in .npmrc	2018-01-11 17:12:04 +02:00
.nycrc	Ignore coverage folder from coverage report	2017-11-30 20:33:23 -05:00
.stylelintrc.yml	Update stylelint rules	2017-11-26 14:28:33 +02:00
.thelounge_home	Deprecate LOUNGE_HOME env var in favor of THELOUNGE_HOME, .lounge_home file in favor of .thelounge_home	2017-11-21 00:36:26 -05:00
.travis.yml	Add Node V9 testing to Travis builds	2017-11-01 02:16:21 -04: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.7.0	2018-01-28 22:19:08 -05:00
CONTRIBUTING.md	Add SECURITY guidelines about security vulnerability disclosures, and link them from the CONTRIBUTING guidelines	2018-01-15 20:26:26 -05:00
index.js	Enable ESLint `no-console` rule to avoid future mistakes	2017-09-17 21:50:21 -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	Merge pull request #2068 from thelounge/greenkeeper/eslint-4.18.0	2018-02-17 00:31:01 -05:00
README.md	Switch CLI tool from `lounge` to `thelounge` and deprecate `lounge`	2017-11-22 16:37:26 -05:00
SECURITY.md	Add SECURITY guidelines about security vulnerability disclosures, and link them from the CONTRIBUTING guidelines	2018-01-15 20:26:26 -05:00
SUPPORT.md	Add a SUPPORT file	2017-08-01 01:41:49 -04:00
webpack.config.js	Do not statically serve the index template prior to rendering it	2018-01-14 13:02:27 -05:00

README.md

The Lounge

Modern web IRC client designed for self-hosting.

Overview

Modern features brought to IRC. Push notifications, link previews, new message markers, and more bring IRC to the 21st century.
Always connected. Remains connected to IRC servers while you are offline.
Cross platform. It doesn't matter what OS you use, it just works wherever Node.js runs.
Responsive interface. The client works smoothly on every desktop, smartphone and tablet.
Synchronized experience. Always resume where you left off no matter what device.

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:

thelounge start

For more information, read the documentation, wiki, or run:

thelounge --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 thelounge 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