Mirrors/thelounge
2
0
Fork 0
mirror of https://github.com/thelounge/thelounge synced 2024-11-23 04:23:13 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
1730 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
Pavel Djundik 2d09e09223 Merge pull request #789 from thelounge/astorije/simpler-readme-intro 
Simplify introduction on README
2016-12-16 21:12:17 +02:00
client Lock input message when app is disconnected 2016-12-14 01:35:32 -05:00
defaults Remove autoload option and always autoload users 2016-12-11 03:29:30 -05:00
scripts Enforce more eslint rules 2016-10-09 17:55:37 -04:00
src Do not accept empty password when adding new user; closes #316 2016-12-13 20:50:15 -08:00
test Merge pull request #749 from thelounge/xpaw/hexip 2016-12-10 19:50:33 -05:00
.editorconfig Add .editorconfig 2015-10-26 03:03:12 +01:00
.eslintignore Add code coverage 2016-06-19 13:07:42 -04:00
.eslintrc.yml Correctly remove closed sockets from oident file, remove unused functions 2016-12-11 08:56:32 +02:00
.gitattributes Add gitattributes to normalize line endings 2016-01-24 16:12:08 +02:00
.gitignore Ignore unnecessary files at release time 2016-07-13 23:57:56 -04:00
.istanbul.yml Add code coverage 2016-06-19 13:07:42 -04:00
.npmignore Ignore unnecessary files at release time 2016-07-13 23:57:56 -04:00
.stylelintrc Update developer dependencies 2016-09-25 14:53:03 +03:00
.travis.yml Add Node.js v7, current stable, to Travis CI 2016-12-16 02:02:48 -05:00
appveyor.yml Invalidate cache and use appveyor-retry with npm 2016-11-25 19:43:24 -08:00
CHANGELOG.md Add change log entry for upcoming v2.1.0 2016-10-17 00:49:48 -04:00
CONTRIBUTING.md Simplify a great deal the CONTRIBUTING file 2016-02-14 20:09:40 +00:00
index.js Enforce strict mode across all JS files with ESLint 2016-10-09 15:14:02 -04: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 irc-framework to bring a couple of fixes 2016-12-11 14:28:10 -05:00
README.md Simplify introduction on README 2016-12-11 04:14:17 -05:00

README.md

The Lounge

#thelounge IRC channel on freenode npm version Travis CI Build Status AppVeyor Build Status Dependencies Status Developer Dependencies Status

The Lounge is a modern web IRC client designed for self-hosting.

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 v4 or more recent.

Running stable releases from npm (recommended)

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

[sudo] npm install -g thelounge

When installation is complete, run:

lounge start

For more information, read the documentation, wiki, or run:

lounge --help

Running from source

The following commands install the development version of The Lounge:

git clone https://github.com/thelounge/lounge.git
cd lounge
npm install
npm start

A word of caution:

  • While it is the most recent codebase, this is not production-ready!
  • It is not recommended to run this as root. However, if you decide to do so, you will have to run npm run build.

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/libs or client/views