mirror of
https://github.com/thelounge/thelounge.git
synced 2024-06-17 13:05:08 +02:00
552fa3fae8
This has several reasons, benefits and consequences: - When running on root (which is not recommended anyway), `npm run build` was already necessary. - This allows to not use the `prepublish` hook, whose behavior is going to change in npm v5 and again in npm v6. - This allows to create both production and development builds when running from source. - It makes `npm run build` compatible with Windows again for development environments (lost in previous commit). - It uses the `prepublishOnly` hook added in npm v4. Since this hook is not available prior to that, deployment to npm from Travis has to be done on the Node.js v7 environment.
70 lines
2.6 KiB
Markdown
70 lines
2.6 KiB
Markdown
# The Lounge
|
|
|
|
[](https://avatar.playat.ch:1000/)
|
|
[](https://www.npmjs.org/package/thelounge)
|
|
[](https://travis-ci.org/thelounge/lounge)
|
|
[](https://ci.appveyor.com/project/astorije/lounge/branch/master)
|
|
[](https://david-dm.org/thelounge/lounge)
|
|
[](https://david-dm.org/thelounge/lounge?type=dev)
|
|
|
|
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](https://thelounge.github.io).
|
|
|
|
<p align="center">
|
|
<img src="https://cloud.githubusercontent.com/assets/5481612/19623041/9bbaec40-9888-11e6-9961-8f3e0493ba30.png" width="550">
|
|
</p>
|
|
|
|
The Lounge is the official and community-managed fork of [Shout](https://github.com/erming/shout), by [Mattias Erming](https://github.com/erming).
|
|
|
|
## Installation and usage
|
|
|
|
The Lounge requires [Node.js](https://nodejs.org/) 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](https://www.npmjs.com/):
|
|
|
|
```sh
|
|
[sudo] npm install -g thelounge
|
|
```
|
|
|
|
When installation is complete, run:
|
|
|
|
```sh
|
|
lounge start
|
|
```
|
|
|
|
For more information, read the [documentation](https://thelounge.github.io/docs/), [wiki](https://github.com/thelounge/lounge/wiki), or run:
|
|
|
|
```sh
|
|
lounge --help
|
|
```
|
|
|
|
### Running from source
|
|
|
|
The following commands install the development version of The Lounge:
|
|
|
|
```sh
|
|
git clone https://github.com/thelounge/lounge.git
|
|
cd lounge
|
|
npm install
|
|
NODE_ENV=production npm run build
|
|
npm start
|
|
```
|
|
|
|
⚠️ 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](https://github.com/thelounge/lounge/blob/master/CONTRIBUTING.md#contributing)
|
|
- 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`
|