thelounge

irc hacktoberfest cross-platform chat web thelounge modern javascript ircv3 irc-client

You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Go to file

Max Leiter 4babd17383 Merge pull request #4715 from progval/test-server-teardown tests/server: Tear down test fixtures in the order they were setup		2 weeks ago
.github	Remove node 12, add node 18. Bump minimum node version 14 (#4552 )	11 months ago
.vscode	TypeScript and Vue 3 (#4559 )	10 months ago
client	Merge pull request #4686 from thelounge/decoupleServer	1 month ago
defaults	Fix misleading LDAP filiter in default config	2 months ago
scripts	Inline logger into changelog script	2 weeks ago
server	Revert "models/chan: don't force existence of constructor properties"	2 weeks ago
shared	Move condensedTypes to shared/	2 months ago
test	add setup	2 weeks ago
.browserslistrc	Use postcss to optimize css	3 years ago
.editorconfig	Set up Prettier on md, html, json, and yaml	4 years ago
.eslintignore	TypeScript and Vue 3 (#4559 )	10 months ago
.eslintrc.cjs	eslint: add shared/	2 months ago
.gitattributes	Add gitattributes to normalize line endings	7 years ago
.gitignore	TypeScript and Vue 3 (#4559 )	10 months ago
.npmrc	Set sign-git-tag to true in .npmrc	5 years ago
.prettierignore	TypeScript and Vue 3 (#4559 )	10 months ago
.thelounge_home	Switch default home location to `~/.thelounge` and remove support of `.lounge_home`	5 years ago
CHANGELOG.md	v4.4.0-pre.2	2 weeks ago
LICENSE	Update LICENSE notice to add ours on top of @erming and Shout	7 years ago
README.md	TypeScript and Vue 3 (#4559 )	10 months ago
SECURITY.md	Change the IRC server to Libera.Chat	2 years ago
babel.config.cjs	TypeScript and Vue 3 (#4559 )	10 months ago
index.js	TypeScript and Vue 3 (#4559 )	10 months ago
package.json	v4.4.0-pre.2	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 )	11 months ago
renovate.json	renovate: Disable digest updates	12 months ago
stylelint.config.cjs	Convert configs to cjs, move babel to own file, combine webpack configs (#4561 )	11 months ago
tsconfig.base.json	base tsconfig: remove files section	2 months ago
tsconfig.json	tsconfig: Add shared reference	2 months ago
volar.config.js	TypeScript and Vue 3 (#4559 )	10 months ago
webpack.config.ts	client: use the versions in shared/ where applicable	2 months ago
yarn.lock	update dependency webpack to v5.76.0	2 weeks ago

README.md

Modern web IRC client designed for self-hosting

Website • Docs • Demo • Docker

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