deblan-mirror/thelounge
deblan-mirror/thelounge
1
0
Fork 0
mirror of https://github.com/thelounge/thelounge.git synced 2024-04-25 03:20:44 +02:00
Code Issues Projects Releases Wiki Activity
7321 commits 50 branches 115 tags 36 MiB
TypeScript 62.3%
Vue 24.1%
CSS 6.9%
JavaScript 6.3%
Smarty 0.3%
Go to file
Reto Brunner e83033dd44 refactor to make code paths easier to follow 
Meaning:
* keep the happy path to the left, test failure conditions first
* extract helpers where needed
2022-04-27 21:06:01 +02:00
.github Remove node 15.x from build matrix 2022-01-27 00:47:43 +01:00
.vscode Add .vscode settings and suggested extensions 2020-08-21 19:27:41 +03:00
client rename class 2022-02-16 15:24:36 +01: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 refactor to make code paths easier to follow 2022-04-27 21:06:01 +02:00
test Add the option to mute channels, queries, and networks (#4282) 2022-02-10 17:56:17 -08: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
.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
.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.0 2021-11-22 17:54:54 -08:00
index.js Format js/vue with prettier 2019-07-19 11:27:40 +01:00
LICENSE
package.json Update dependency cssnano to v5.0.17 (#4441) 2022-02-10 16:27:12 -08: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 Have Renovate bot refresh our lockfile for us. 2022-02-02 14:37:24 -08: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 Lock file maintenance (#4479) 2022-02-13 16:41:18 -08: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