a55dc206bb
It's time to move on from yarn 1, imo. Not that I contribute enough to care, but it was frustrating to use yarn while setting my local repo up again. |
||
---|---|---|
.github | ||
.vscode | ||
client | ||
defaults | ||
scripts | ||
server | ||
shared | ||
test | ||
.browserslistrc | ||
.editorconfig | ||
.eslintignore | ||
.eslintrc.cjs | ||
.gitattributes | ||
.gitignore | ||
.npmrc | ||
.prettierignore | ||
.thelounge_home | ||
babel.config.cjs | ||
CHANGELOG.md | ||
index.js | ||
LICENSE | ||
package.json | ||
pnpm-lock.yaml | ||
postcss.config.js | ||
prettier.config.cjs | ||
README.md | ||
renovate.json | ||
SECURITY.md | ||
stylelint.config.cjs | ||
tsconfig.base.json | ||
tsconfig.json | ||
volar.config.js | ||
webpack.config.ts |
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 pnpm 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
pnpm install
NODE_ENV=production pnpm build
pnpm 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
pnpm test
to execute linters and the test suite- Run
pnpm format:prettier
if linting fails
- Run
- Run
pnpm build:client
if you change or add anything inclient/js
orclient/components
- The built files will be output to
public/
by webpack
- The built files will be output to
- Run
pnpm build:server
if you change anything inserver/
- The built files will be output to
dist/
by tsc
- The built files will be output to
pnpm 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.
Execute pnpm githooks-install
to do so.