Go to file
Max Leiter 4eea858a14
progress
2022-06-02 20:02:24 -07:00
.github Remove node 12, add node 18. Bump minimum node version 14 (#4552) 2022-04-30 13:12:24 -07:00
.vscode Replace vetur with volar, small types cleanup 2022-06-01 11:45:08 -07:00
client progress 2022-06-02 20:02:24 -07:00
defaults Apply fixes suggested by Prettier to fix CI 2022-04-09 19:40:38 +00:00
scripts ts progress 2022-05-21 11:47:49 -07:00
src progress 2022-06-02 20:02:24 -07:00
test Replace vetur with volar, small types cleanup 2022-06-01 11:45:08 -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 some test fixes 2022-05-21 11:56:03 -07:00
.eslintrc.cjs Fix some tests / linting 2022-05-30 12:54:33 -07:00
.gitattributes Add gitattributes to normalize line endings 2016-01-24 16:12:08 +02:00
.gitignore some test fixes 2022-05-21 11:56:03 -07:00
.npmignore client, some tests, eslint 2022-05-21 11:49:33 -07:00
.npmrc Set sign-git-tag to true in .npmrc 2018-01-11 17:12:04 +02:00
.prettierignore some test fixes 2022-05-21 11:56:03 -07: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.1 2022-04-11 17:26:23 -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 README: suggest running 'yarn format:prettier' when linting fails (#4467) 2022-02-08 17:52:07 -08:00
SECURITY.md Change the IRC server to Libera.Chat 2021-05-23 16:40:08 +02:00
babel.config.cjs add @babel/plugin-transform-runtime, fix scrolling on chan switch/history loading 2022-05-30 21:10:11 -07:00
package.json Convert two messages to composition API, downgrade textcomplete to fix mobile, re-add an env var to webpack 2022-06-02 00:04:21 -07:00
postcss.config.js Use postcss to optimize css 2019-11-01 13:47:18 +02:00
prettier.config.cjs Convert configs to cjs, move babel to own file, combine webpack configs (#4561) 2022-05-02 19:19:12 -07:00
renovate.json renovate: Disable digest updates 2022-04-13 21:48:21 +02:00
stylelint.config.cjs Convert configs to cjs, move babel to own file, combine webpack configs (#4561) 2022-05-02 19:19:12 -07:00
tsconfig.base.json bump eslint, fix tsconfig helper issue 2022-05-31 18:37:02 -07:00
tsconfig.json bump eslint, fix tsconfig helper issue 2022-05-31 18:37:02 -07:00
webpack.config.ts Convert two messages to composition API, downgrade textcomplete to fix mobile, re-add an env var to webpack 2022-06-02 00:04:21 -07:00
yarn.lock Convert two messages to composition API, downgrade textcomplete to fix mobile, re-add an env var to webpack 2022-06-02 00:04:21 -07:00

README.md

The Lounge

Modern web IRC client designed for self-hosting

WebsiteDocsDemoDocker

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

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 the test suite
    • Run yarn format:prettier if linting fails
  • 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