Go to file
Max Leiter b1f67a5837
Fix quitMessage spelling
2021-09-30 14:28:54 -07:00
.github Change the IRC server to Libera.Chat 2021-05-23 16:40:08 +02:00
.vscode Add .vscode settings and suggested extensions 2020-08-21 19:27:41 +03:00
client Show quit dialog when using /quit 2021-09-30 14:25:35 -07:00
defaults Change the IRC server to Libera.Chat 2021-05-23 16:40:08 +02:00
scripts Update emoji map 2021-07-06 01:31:24 -07:00
src Fix quitMessage spelling 2021-09-30 14:28:54 -07:00
test Properly track user modes for context menu (#4267) 2021-07-21 00:30:07 -07:00
.browserslistrc Use postcss to optimize css 2019-11-01 13:47:18 +02:00
.editorconfig Set up Prettier on md, html, json, and yaml 2019-07-17 10:22:30 +01:00
.eslintignore Remove old path from eslintignore 2019-11-25 20:12:49 +02:00
.eslintrc.yml Prevent possible error when findChannel can't find the wanted channel 2021-05-05 18:09:18 +02:00
.gitattributes Add gitattributes to normalize line endings 2016-01-24 16:12:08 +02:00
.gitignore Move .nyc_output folder out of root 2018-06-16 12:13:29 +03:00
.npmignore Convert constants.js to commonjs 2019-12-18 00:14:36 +02:00
.npmrc Set sign-git-tag to true in .npmrc 2018-01-11 17:12:04 +02:00
.prettierignore Format prettier after update 2019-11-09 10:55:50 +02:00
.prettierrc.yml Set up prettier on js/vue 2019-07-19 11:24:30 +01:00
.stylelintrc.yml Update dependencies 2020-09-02 10:38:16 +03:00
.thelounge_home Switch default home location to `~/.thelounge` and remove support of `.lounge_home` 2018-02-19 20:43:53 +02:00
CHANGELOG.md Add changelog entry for v4.3.0-pre.4 2021-07-01 12:20:41 -07:00
LICENSE Update LICENSE notice to add ours on top of @erming and Shout 2016-02-10 06:20:05 +00:00
README.md Change the IRC server to Libera.Chat 2021-05-23 16:40:08 +02:00
SECURITY.md Change the IRC server to Libera.Chat 2021-05-23 16:40:08 +02:00
index.js Format js/vue with prettier 2019-07-19 11:27:40 +01:00
package.json Update dependencies (#4312) 2021-09-15 10:12:19 -07:00
postcss.config.js Use postcss to optimize css 2019-11-01 13:47:18 +02:00
renovate.json Add depTypeList 2020-09-18 11:51:12 +03:00
webpack.config-test.js Upgrade mocha and remove mochapack 2020-04-11 12:27:08 +03:00
webpack.config.js Revert "Support animated webp images" (#4287) 2021-08-31 12:27:43 -07:00
yarn.lock Update dependencies (#4312) 2021-09-15 10:12:19 -07:00

README.md

The Lounge

Modern web IRC client designed for self-hosting

WebsiteDocsDemo

#thelounge IRC channel on Libera.Chat npm version Build Status Total downloads on npm

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 latest Node.js LTS version or more recent. Yarn package manager is also recommended.
If you want to install with npm, --unsafe-perm is required for a correct install.

Running stable releases

Please refer to the install and upgrade documentation on our website for all available installation methods.

Running from source

The following commands install and run the development version of The Lounge:

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

When installed like this, thelounge executable is not created. Use node index <command> to run commands.

⚠️ 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 yarn test to execute linters and test suite
  • Run yarn build if you change or add anything in client/js or client/components
  • yarn dev can be used to start The Lounge with hot module reloading