Update readme and license
This commit is contained in:
parent
428974baa1
commit
c135b7785a
SSH Key Fingerprint:
SHA256:diG7RVYHjd3aDYkZWHYcBJbImu+6zfptuUP+3k/wol4
1
LICENSE
1
LICENSE
|
|
@ -1,5 +1,6 @@
|
|||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2023 SuperNETs
|
||||
Copyright (c) 2016 All contributors to The Lounge
|
||||
Copyright (c) 2014 Mattias Erming and contributors, as part of Shout.
|
||||
|
||||
|
|
|
|||
97
README.md
97
README.md
|
|
@ -1,92 +1,15 @@
|
|||
<h1 align="center">
|
||||
<img
|
||||
width="300"
|
||||
alt="The Lounge"
|
||||
src="https://raw.githubusercontent.com/thelounge/thelounge/master/client/img/logo-vertical-transparent-bg.svg?sanitize=true">
|
||||
</h1>
|
||||
# The Lounge: Hard Chats Edition
|
||||
|
||||
<h3 align="center">
|
||||
Modern web IRC client designed for self-hosting
|
||||
</h3>
|
||||
This is a fork of The Lounge intended to be used for the SuperNETs Webchat (located at https://webchat.supernets.org)
|
||||
|
||||
<p align="center">
|
||||
<strong>
|
||||
<a href="https://thelounge.chat/">Website</a>
|
||||
•
|
||||
<a href="https://thelounge.chat/docs">Docs</a>
|
||||
•
|
||||
<a href="https://demo.thelounge.chat/">Demo</a>
|
||||
•
|
||||
<a href="https://github.com/thelounge/thelounge-docker">Docker</a>
|
||||
</strong>
|
||||
</p>
|
||||
<p align="center">
|
||||
<a href="https://demo.thelounge.chat/"><img
|
||||
alt="#thelounge IRC channel on Libera.Chat"
|
||||
src="https://img.shields.io/badge/Libera.Chat-%23thelounge-415364.svg?colorA=ff9e18"></a>
|
||||
<a href="https://yarn.pm/thelounge"><img
|
||||
alt="npm version"
|
||||
src="https://img.shields.io/npm/v/thelounge.svg?colorA=333a41&maxAge=3600"></a>
|
||||
<a href="https://github.com/thelounge/thelounge/actions"><img
|
||||
alt="Build Status"
|
||||
src="https://github.com/thelounge/thelounge/workflows/Build/badge.svg"></a>
|
||||
</p>
|
||||
# Deployment
|
||||
|
||||
<p align="center">
|
||||
<img src="https://raw.githubusercontent.com/thelounge/thelounge.github.io/master/img/thelounge-screenshot.png" width="550">
|
||||
</p>
|
||||
1. Create a `docker-compose.yml` file in the directory you wish The Lounge to be in, use the one in this repo as an example.
|
||||
2. Create the `config/` folder in the same directory.
|
||||
3. Run `docker compose up` to bring up the container and generate required files, you may Ctrl+C it after that.
|
||||
4. Edit the config file located at `config/config.js`, it is well documented and has not been changed so the original The Lounge documentation applies here.
|
||||
5. Bring up the container for good using `docker compose up -d`.
|
||||
|
||||
## Overview
|
||||
# Support
|
||||
|
||||
- **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](https://thelounge.chat).
|
||||
|
||||
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 latest [Node.js](https://nodejs.org/) LTS version or more recent.
|
||||
The [Yarn package manager](https://yarnpkg.com/) is also recommended.
|
||||
If you want to install with npm, `--unsafe-perm` is required for a correct install.
|
||||
|
||||
### Running stable releases
|
||||
|
||||
Please refer to the [install and upgrade documentation on our website](https://thelounge.chat/docs/install-and-upgrade) for all available installation methods.
|
||||
|
||||
### Running from source
|
||||
|
||||
The following commands install and run the development version of The Lounge:
|
||||
|
||||
```sh
|
||||
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](https://github.com/thelounge/thelounge/blob/master/.github/CONTRIBUTING.md#contributing)
|
||||
- Run `yarn test` to execute linters and the test suite
|
||||
- Run `yarn format:prettier` if linting fails
|
||||
- Run `yarn build:client` if you change or add anything in `client/js` or `client/components`
|
||||
- The built files will be output to `public/` by webpack
|
||||
- Run `yarn build:server` if you change anything in `server/`
|
||||
- The built files will be output to `dist/` by tsc
|
||||
- `yarn dev` can be used to start The Lounge with hot module reloading
|
||||
If for some reason you decide to run our version of this container, we are more than happy to support you in #5000 on irc.supernets.org
|
||||
|
|
|
|||
|
|
@ -0,0 +1,92 @@
|
|||
<h1 align="center">
|
||||
<img
|
||||
width="300"
|
||||
alt="The Lounge"
|
||||
src="https://raw.githubusercontent.com/thelounge/thelounge/master/client/img/logo-vertical-transparent-bg.svg?sanitize=true">
|
||||
</h1>
|
||||
|
||||
<h3 align="center">
|
||||
Modern web IRC client designed for self-hosting
|
||||
</h3>
|
||||
|
||||
<p align="center">
|
||||
<strong>
|
||||
<a href="https://thelounge.chat/">Website</a>
|
||||
•
|
||||
<a href="https://thelounge.chat/docs">Docs</a>
|
||||
•
|
||||
<a href="https://demo.thelounge.chat/">Demo</a>
|
||||
•
|
||||
<a href="https://github.com/thelounge/thelounge-docker">Docker</a>
|
||||
</strong>
|
||||
</p>
|
||||
<p align="center">
|
||||
<a href="https://demo.thelounge.chat/"><img
|
||||
alt="#thelounge IRC channel on Libera.Chat"
|
||||
src="https://img.shields.io/badge/Libera.Chat-%23thelounge-415364.svg?colorA=ff9e18"></a>
|
||||
<a href="https://yarn.pm/thelounge"><img
|
||||
alt="npm version"
|
||||
src="https://img.shields.io/npm/v/thelounge.svg?colorA=333a41&maxAge=3600"></a>
|
||||
<a href="https://github.com/thelounge/thelounge/actions"><img
|
||||
alt="Build Status"
|
||||
src="https://github.com/thelounge/thelounge/workflows/Build/badge.svg"></a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<img src="https://raw.githubusercontent.com/thelounge/thelounge.github.io/master/img/thelounge-screenshot.png" width="550">
|
||||
</p>
|
||||
|
||||
## 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](https://thelounge.chat).
|
||||
|
||||
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 latest [Node.js](https://nodejs.org/) LTS version or more recent.
|
||||
The [Yarn package manager](https://yarnpkg.com/) is also recommended.
|
||||
If you want to install with npm, `--unsafe-perm` is required for a correct install.
|
||||
|
||||
### Running stable releases
|
||||
|
||||
Please refer to the [install and upgrade documentation on our website](https://thelounge.chat/docs/install-and-upgrade) for all available installation methods.
|
||||
|
||||
### Running from source
|
||||
|
||||
The following commands install and run the development version of The Lounge:
|
||||
|
||||
```sh
|
||||
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](https://github.com/thelounge/thelounge/blob/master/.github/CONTRIBUTING.md#contributing)
|
||||
- Run `yarn test` to execute linters and the test suite
|
||||
- Run `yarn format:prettier` if linting fails
|
||||
- Run `yarn build:client` if you change or add anything in `client/js` or `client/components`
|
||||
- The built files will be output to `public/` by webpack
|
||||
- Run `yarn build:server` if you change anything in `server/`
|
||||
- The built files will be output to `dist/` by tsc
|
||||
- `yarn dev` can be used to start The Lounge with hot module reloading
|
||||
Loading…
Reference in New Issue