deblan-mirror/thelounge
deblan-mirror/thelounge
1
0
Fork 0
mirror of https://github.com/thelounge/thelounge.git synced 2024-04-26 12:02:00 +02:00
Code Issues Projects Releases Wiki Activity
4503 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
Jérémie Astori 5f190fc165
3.0.0-pre.8
2018-08-25 02:14:03 -04:00
.github Merge pull request #2604 from Zarthus/issue_templates 2018-07-07 12:19:19 -04:00
client Fix confirmation box text for network removal in client 2018-08-24 12:32:25 +02:00
defaults Re-order and improve inline comments of config.js 2018-07-18 01:42:04 -04:00
scripts Merge pull request #2645 from thelounge/astorije/better-docs 2018-07-21 02:12:37 -04:00
src Pass network name along to the client connect window when network is locked and not displayed 2018-08-11 18:10:13 -04:00
test refactor getHumanDate() to accept a timestamp; fixes test 2018-07-22 00:27:49 -07:00
.editorconfig
.eslintignore
.eslintrc.yml Update no-confusing-error eslint rule to allow parenthesis 2018-06-26 00:35:02 -07:00
.gitattributes
.gitignore
.npmignore
.npmrc
.stylelintrc.yml
.thelounge_home
.travis.yml
appveyor.yml
CHANGELOG.md Add changelog entry for v3.0.0-pre.8 2018-08-25 02:13:50 -04:00
index.js
LICENSE
package.json 3.0.0-pre.8 2018-08-25 02:14:03 -04:00
README.md Remove [sudo] for Yarn install/upgrade command in README.md 2018-07-19 09:36:23 +02:00
renovate.json
SECURITY.md
webpack.config-browser.js
webpack.config-test.js
webpack.config.js
yarn.lock chore(deps): update dependency webpack to v4.17.1 2018-08-22 09:58:48 +00: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 AppVeyor 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 Node.js v6 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 documentation, wiki, 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 npm test to execute linters and test suite
  • Run npm run build if you change or add anything in client/js or client/views