hardlounge/README.md
Jérémie Astori fe6da75854 Remove compiled assets and generate them at prepublish time
- Remove minified libs and compiled templates
- Add a `prepublish` script to build assets, that run on `npm install`
  and right before publishing
  See https://docs.npmjs.com/misc/scripts
- Include these compiled assets to the `.gitignore` file
- Add an empty .npmignore to make sure the compiled assets are not
  ignored when publishing
  https://docs.npmjs.com/misc/developers#keeping-files-out-of-your-package
- Update the README to reflect changes in development

Note that the Travis CI configuration does not need any tweaking
because it cleans up all extra and changed files, up to publishing on
npm. That is, right before `prepublish` gets run.
See https://docs.travis-ci.com/user/deployment/npm#Releasing-build-artifacts
2016-02-18 06:01:37 +00:00

1.7 KiB

#thelounge IRC channel on freenode npm version Build Status Dependency Status devDependency Status

The Lounge

What is it?

The Lounge is a web IRC client that you host on your own server.

This is the official, community-managed fork of @erming's great initiative, the Shout project.

What features does it have?

  • Multiple user support
  • Stays connected even when you close the browser
  • Connect from multiple devices at once
  • Responsive layout — works well on your smartphone
  • .. and more!

Install

sudo npm install -g thelounge

Usage

When the install is complete, go ahead and run this in your terminal:

lounge --help

For more information, read the documentation.

Development setup

To run the app from source, just clone the code and run this in your terminal:

npm install
npm start

You will have to run npm run build if you change or add anything in client/js/libs or client/views.

License

Available under the MIT License.

Some fonts licensed under SIL OFL and the Apache License.