Mirrors/thelounge
2
0
Fork 0
mirror of https://github.com/thelounge/thelounge synced 2024-11-10 14:44:13 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
6787 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
Renovate Bot b7035d3cae
Update dependency stylelint to v13.6.1
2020-06-22 08:58:30 +00:00
.github Exclude node 10 on macOS from build matrix 2020-04-11 12:19:05 +03:00
client Merge pull request #3889 from timmw/timmw/vue3-prep 2020-04-28 22:10:55 +03:00
defaults Combine displayNetwork into lockNetwork 2020-04-15 10:56:05 +03:00
scripts Run format after updating to prettier 2.0 2020-03-21 22:55:36 +02:00
src Merge branch 'renovate/mocha-8.x' 2020-06-14 12:34:07 +03:00
test Update CopyPlugin options 2020-05-16 21:33:25 +03: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 Remove vue/no-use-v-if-with-v-for eslint override 2020-04-28 20:05:46 +01: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 Use postcss to optimize css 2019-11-01 13:47:18 +02: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.2.0-pre.1 2020-05-17 16:23:46 +03:00
index.js Format js/vue with prettier 2019-07-19 11:27:40 +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 Update dependency stylelint to v13.6.1 2020-06-22 08:58:30 +00:00
postcss.config.js Use postcss to optimize css 2019-11-01 13:47:18 +02:00
README.md Link to official docs for stable releases 2019-12-31 18:51:49 +02:00
renovate.json Create devDependencies update prs on weekends 2019-10-14 12:28:05 +03:00
SECURITY.md Remove mailto: part of security email address 2018-03-12 03:54:10 -04:00
webpack.config-test.js Upgrade mocha and remove mochapack 2020-04-11 12:27:08 +03:00
webpack.config.js Update CopyPlugin options 2020-05-16 21:33:25 +03:00
yarn.lock Update dependency stylelint to v13.6.1 2020-06-22 08:58:30 +00:00

README.md

The Lounge

Modern web IRC client designed for self-hosting

Website • Docs • Demo

#thelounge IRC channel on freenode npm version Build Status Total downloads on npm

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