You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Reto Brunner deeea274da Merge branch 'sqlite_cleanup' 1 week ago
.github Remove node 12, add node 18. Bump minimum node version 14 (#4552) 7 months ago
.vscode TypeScript and Vue 3 (#4559) 6 months ago
client Merge branch 'search' 1 week ago
defaults Use nick as a realname fallback 3 months ago
scripts TypeScript and Vue 3 (#4559) 6 months ago
server Merge branch 'sqlite_cleanup' 1 week ago
test Merge branch 'sqlite_cleanup' 1 week ago
.browserslistrc Use postcss to optimize css 3 years ago
.editorconfig Set up Prettier on md, html, json, and yaml 3 years ago
.eslintignore TypeScript and Vue 3 (#4559) 6 months ago
.eslintrc.cjs TypeScript and Vue 3 (#4559) 6 months ago
.gitattributes Add gitattributes to normalize line endings 7 years ago
.gitignore TypeScript and Vue 3 (#4559) 6 months ago
.npmignore TypeScript and Vue 3 (#4559) 6 months ago
.npmrc Set sign-git-tag to true in .npmrc 5 years ago
.prettierignore TypeScript and Vue 3 (#4559) 6 months ago
.thelounge_home Switch default home location to `~/.thelounge` and remove support of `.lounge_home` 5 years ago
CHANGELOG.md Add changelog entry for v4.3.1 8 months ago
LICENSE Update LICENSE notice to add ours on top of @erming and Shout 7 years ago
README.md TypeScript and Vue 3 (#4559) 6 months ago
SECURITY.md Change the IRC server to Libera.Chat 2 years ago
babel.config.cjs TypeScript and Vue 3 (#4559) 6 months ago
index.js TypeScript and Vue 3 (#4559) 6 months ago
package.json bump socket.io-client to 4.5.0 2 weeks ago
postcss.config.js Use postcss to optimize css 3 years ago
prettier.config.cjs Convert configs to cjs, move babel to own file, combine webpack configs (#4561) 7 months ago
renovate.json renovate: Disable digest updates 8 months ago
stylelint.config.cjs Convert configs to cjs, move babel to own file, combine webpack configs (#4561) 7 months ago
tsconfig.base.json TypeScript and Vue 3 (#4559) 6 months ago
tsconfig.json TypeScript and Vue 3 (#4559) 6 months ago
volar.config.js TypeScript and Vue 3 (#4559) 6 months ago
webpack.config.ts Added client type checking to webpack (#4619) 3 months ago
yarn.lock Bump engine.io from 6.2.0 to 6.2.1 2 weeks ago

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. The 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:client if you change or add anything in client/js or client/components
    • The built files will be output to public/ by webpack
  • Run yarn build:server if you change anything in server/
    • The built files will be output to dist/ by tsc
  • yarn dev can be used to start The Lounge with hot module reloading