💬 Modern, responsive, cross-platform, self-hosted web IRC client
<a href="https://raw.githubusercontent.com/thelounge/thelounge/master/client/img/logo-vertical-transparent-bg.svg?sanitize=true" rel="nofollow"></a>
Modern web IRC client designed for self-hosting
Website • Docs • Demo • Docker
Overview
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:
yarn test
to execute linters and the test suite
yarn format:prettier
if linting failsyarn build:client
if you change or add anything in client/js
or client/components
public/
by webpackyarn build:server
if you change anything in server/
dist/
by tscyarn dev
can be used to start The Lounge with hot module reloadingTwice a month we will interview people behind open source businesses. We will talk about how they are building a business on top of open source projects.
We'll never share your email with anyone else.