Repository files navigation

Website•Docs•Demo •Docker

• 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 atthe website.

The Lounge is the official and community-managed fork ofShout, byMattias Erming.

The Lounge requires latestNode.js LTS version or more recent.TheYarn package manager is also recommended.If you want to install with npm,--unsafe-perm is required for a correct install.

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

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

git clone https://github.com/thelounge/thelounge.gitcd theloungeyarn installNODE_ENV=production yarn buildyarn start

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

⚠️ While it is the most recent codebase, this is not production-ready! Run atyour own risk. It is also not recommended to run this as root.

Simply follow the instructions to run The Lounge from source above, on your ownfork.

Before submitting any change, make sure to:

• Read theContributing instructions
• Runyarn test to execute linters and the test suite
  • Runyarn format:prettier if linting fails
• Runyarn build:client if you change or add anything inclient/js orclient/components
  • The built files will be output topublic/ by webpack
• Runyarn build:server if you change anything inserver/
  • The built files will be output todist/ by tsc
• yarn dev can be used to start The Lounge with hot module reloading

To ensure that you don't commit files that fail the linting, you can install a pre-commit git hook.Executeyarn githooks-install to do so.