From c135b7785a8ca78a4cfac806a25ca56eb0bfcee6 Mon Sep 17 00:00:00 2001 From: hgw Date: Thu, 5 Oct 2023 09:26:50 +0000 Subject: [PATCH] Update readme and license --- LICENSE | 1 + README.md | 97 ++++++------------------------------------------------ README.old | 92 +++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 103 insertions(+), 87 deletions(-) create mode 100644 README.old diff --git a/LICENSE b/LICENSE index 6f9d3213..ef1b2821 100644 --- a/LICENSE +++ b/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. diff --git a/README.md b/README.md index 31665ab7..1d8985d0 100644 --- a/README.md +++ b/README.md @@ -1,92 +1,15 @@ -

- The Lounge -

+# The Lounge: Hard Chats Edition -

- Modern web IRC client designed for self-hosting -

+This is a fork of The Lounge intended to be used for the SuperNETs Webchat (located at https://webchat.supernets.org) -

- - Website - • - Docs - • - Demo - • - Docker - -

-

- #thelounge IRC channel on Libera.Chat - npm version - Build Status -

+# Deployment -

- -

+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 ` 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 diff --git a/README.old b/README.old new file mode 100644 index 00000000..31665ab7 --- /dev/null +++ b/README.old @@ -0,0 +1,92 @@ +

+ The Lounge +

+ +

+ Modern web IRC client designed for self-hosting +

+ +

+ + Website + • + Docs + • + Demo + • + Docker + +

+

+ #thelounge IRC channel on Libera.Chat + npm version + Build Status +

+ +

+ +

+ +## 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 ` 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