d62dd3e62d
Message stores are more complicated that a sync "fire and forget" API allows for. For starters, non trivial stores (say sqlite) can fail during init and we want to be able to catch that. Second, we really need to be able to run migrations and such, which may block (and fail) the activation of the store. On the plus side, this pushes error handling to the caller rather than the stores, which is a good thing as that allows us to eventually push this to the client in the UI, rather than just logging it in the server on stdout |
||
---|---|---|
.github | ||
.vscode | ||
client | ||
defaults | ||
scripts | ||
server | ||
test | ||
.browserslistrc | ||
.editorconfig | ||
.eslintignore | ||
.eslintrc.cjs | ||
.gitattributes | ||
.gitignore | ||
.npmignore | ||
.npmrc | ||
.prettierignore | ||
.thelounge_home | ||
babel.config.cjs | ||
CHANGELOG.md | ||
index.js | ||
LICENSE | ||
package.json | ||
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 | ||
yarn.lock |
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
- Run
yarn 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
yarn build:server
if you change anything inserver/
- The built files will be output to
dist/
by tsc
- The built files will be output to
yarn dev
can be used to start The Lounge with hot module reloading