Mirrors/thelounge
2
0
Fork 0
mirror of https://github.com/thelounge/thelounge synced 2024-11-25 21:40:22 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
5726 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 5a94727d79 Bump minimum node version to v10
2019-09-04 22:50:25 +03:00
.github Add prettier info to CONTRIBUTING.md 2019-07-19 11:30:43 +01:00
client Merge pull request #3382 from thelounge/xpaw/upload-fixes 2019-08-27 12:21:03 +03:00
defaults Store ip and language in a separate object in user file 2019-07-16 13:00:29 +03:00
scripts Allow saving github token to a file 2019-08-13 12:43:47 +03:00
src Bump minimum node version to v10 2019-09-04 22:50:25 +03:00
test Format js/vue with prettier 2019-07-19 11:27:40 +01:00
.editorconfig Set up Prettier on md, html, json, and yaml 2019-07-17 10:22:30 +01:00
.eslintignore Create public folder with webpack 2017-10-18 21:20:12 +03:00
.eslintrc.yml Remove linebreak-style 2019-07-19 14:44:46 +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 Replace Greenkeeper with Renovate 2018-05-15 09:56:23 +03:00
.npmrc Set sign-git-tag to true in .npmrc 2018-01-11 17:12:04 +02:00
.prettierignore Set up prettier on js/vue 2019-07-19 11:24:30 +01:00
.prettierrc.yml Set up prettier on js/vue 2019-07-19 11:24:30 +01:00
.stylelintrc.yml Update stylelint rules 2017-11-26 14:28:33 +02:00
.thelounge_home Switch default home location to ~/.thelounge and remove support of .lounge_home 2018-02-19 20:43:53 +02:00
.travis.yml Bump minimum node version to v10 2019-09-04 22:50:25 +03:00
CHANGELOG.md Add changelog entry for v3.2.0 2019-08-18 21:52:32 +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 Bump minimum node version to v10 2019-09-04 22:50:25 +03:00
README.md Bump minimum node version to v10 2019-09-04 22:50:25 +03:00
renovate.json Set up Prettier on md, html, json, and yaml 2019-07-17 10:22:30 +01:00
SECURITY.md Remove mailto: part of security email address 2018-03-12 03:54:10 -04:00
webpack.config-test.js Format js/vue with prettier 2019-07-19 11:27:40 +01:00
webpack.config.js Format js/vue with prettier 2019-07-19 11:27:40 +01:00
yarn.lock Merge pull request #3383 from thelounge/renovate/webpack-4.x 2019-09-04 13:20:11 +03:00

README.md

The Lounge

Modern web IRC client designed for self-hosting

Website • Docs • Demo

#thelounge IRC channel on freenode
npm version Travis CI Build Status Dependencies 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 using Yarn (recommended)

Run this in a terminal to install (or upgrade) the latest stable release from npm registry:

yarn global add thelounge

If you already have The Lounge installed globally, use the following command to update it:

yarn global upgrade thelounge

When installation is complete, run:

thelounge start

For more information, read the usage documentation or run:

thelounge --help

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 and watch for any file changes in the client folder