Mirrors/thelounge
2
0
Fork 0
mirror of https://github.com/thelounge/thelounge synced 2024-11-25 05:20:21 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
7363 commits 47 branches 115 tags 39 MiB
TypeScript 62.6%
Vue 23.9%
CSS 6.8%
JavaScript 6.3%
Smarty 0.3%
Find a file
Reto Brunner c9c8cadb1a Merge pull/4477 Preserve client certificate
2022-04-27 17:58:09 +02:00
.github Update actions/setup-node action to v3 (#4496) 2022-03-02 16:31:28 -08:00
.vscode Add .vscode settings and suggested extensions 2020-08-21 19:27:41 +03:00
client Fix topic wrapping on mobile 2022-04-17 19:07:56 +03:00
defaults Added 'to* in a sentence 2022-02-01 11:31:34 +01:00
scripts Bump most deps (#4453) 2022-02-09 15:27:34 -08:00
src Merge pull/4477 Preserve client certificate 2022-04-27 17:58:09 +02:00
test Merge pull/4477 Preserve client certificate 2022-04-27 17:58:09 +02:00
.browserslistrc Use postcss to optimize css 2019-11-01 13:47:18 +02:00
.editorconfig Set up Prettier on md, html, json, and yaml 2019-07-17 10:22:30 +01:00
.eslintignore Remove old path from eslintignore 2019-11-25 20:12:49 +02:00
.eslintrc.yml Bump most deps (#4453) 2022-02-09 15:27:34 -08:00
.gitattributes Add gitattributes to normalize line endings 2016-01-24 16:12:08 +02:00
.gitignore Move .nyc_output folder out of root 2018-06-16 12:13:29 +03:00
.npmignore Convert constants.js to commonjs 2019-12-18 00:14:36 +02:00
.npmrc Set sign-git-tag to true in .npmrc 2018-01-11 17:12:04 +02:00
.prettierignore Format prettier after update 2019-11-09 10:55:50 +02:00
.prettierrc.yml Set up prettier on js/vue 2019-07-19 11:24:30 +01:00
.stylelintrc.yml Bump most deps (#4453) 2022-02-09 15:27:34 -08:00
.thelounge_home Switch default home location to ~/.thelounge and remove support of .lounge_home 2018-02-19 20:43:53 +02:00
CHANGELOG.md Add changelog entry for v4.3.1 2022-04-11 17:26:23 -07:00
index.js Use the DNS result order returned by the OS 2022-02-15 07:44:13 +01:00
LICENSE Update LICENSE notice to add ours on top of @erming and Shout 2016-02-10 06:20:05 +00:00
package.json Merge pull request #4541 from thelounge/renovate/sqlite3-5.x 2022-04-19 17:23:23 -07:00
postcss.config.js Use postcss to optimize css 2019-11-01 13:47:18 +02:00
README.md README: suggest running 'yarn format:prettier' when linting fails (#4467) 2022-02-08 17:52:07 -08:00
renovate.json renovate: Disable digest updates 2022-04-13 21:48:21 +02:00
SECURITY.md Change the IRC server to Libera.Chat 2021-05-23 16:40:08 +02:00
webpack.config-test.js Upgrade mocha and remove mochapack 2020-04-11 12:27:08 +03:00
webpack.config.js Bump most deps (#4453) 2022-02-09 15:27:34 -08:00
yarn.lock Merge pull request #4541 from thelounge/renovate/sqlite3-5.x 2022-04-19 17:23:23 -07:00

README.md

The Lounge

Modern web IRC client designed for self-hosting

Website • Docs • Demo • Docker

#thelounge IRC channel on Libera.Chat npm version Build Status

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. 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 if you change or add anything in client/js or client/components
  • yarn dev can be used to start The Lounge with hot module reloading