Mirrors/thelounge
2
0
Fork 0
mirror of https://github.com/thelounge/thelounge synced 2024-11-26 22:10:22 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
6495 commits 47 branches 115 tags 40 MiB
TypeScript 62.6%
Vue 23.9%
CSS 6.8%
JavaScript 6.3%
Smarty 0.3%
Find a file
Pavel Djundik d9985e7318 Enforce STS policies
2020-02-27 13:48:47 +02:00
.github Merge pull request #3454 from Zarthus/gh_labels 2019-12-15 13:29:03 +02:00
client Add an explanation why push notifications are not supported on iOS 2020-02-25 20:04:33 +02:00
defaults Allow configure base url for uploads 2019-10-31 13:21:22 +02:00
scripts Remove \uFE0F emoji variant from emoji name map 2019-11-26 14:17:37 +02:00
src Enforce STS policies 2020-02-27 13:48:47 +02:00
test Fix increasing test timeout on github actions 2020-02-09 14:21:45 +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 ecmaVersion to 2018 2019-10-20 00:00:15 +03: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 for v4.0.0 2019-12-31 18:02:26 +02: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 Merge pull request #3780 from thelounge/renovate/uuid-7.x 2020-02-27 13:48:32 +02: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 Remove references to vue.js 2019-11-25 20:13:09 +02:00
webpack.config.js Disable SW caching in dev build 2020-01-09 22:40:10 +02:00
yarn.lock Merge pull request #3780 from thelounge/renovate/uuid-7.x 2020-02-27 13:48:32 +02: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