hack-chat-main/README.md

# hack.chat

[hack.chat](https://hack.chat/) is a minimal, distraction-free, accountless, logless, disappearing chat service which is easily deployable as your own service. The current client comes bundled with LaTeX rendering provided by [KaTeX](https://github.com/Khan/KaTeX) and code syntax highlighting provided by [highlight.js](https://github.com/isagalaev/highlight.js).

A list of software developed for the hack.chat framework can be found at the [3rd party software list](https://github.com/hack-chat/3rd-party-software-list) repository. This includes bots, clients, docker containers, etc.

This is a backwards compatible continuation of the [work by Andrew Belt](https://github.com/AndrewBelt/hack.chat). The server code has been updated to ES6 along with several new features including new commands and hot-reload of the commands/protocol. There is also [documentation](documentation/index.html).

# Installation

## Prerequisites

- [node.js v16.14.0](https://nodejs.org/) or higher
- [npm 8.5.4](https://nodejs.org/) or higher

## Developer Installation

1. [Clone](https://help.github.com/articles/cloning-a-repository/) the repository: `git clone https://github.com/hack-chat/main.git`
1. Change the directory: `cd main`
1. Install the dependencies: `npm install`
1. Launch: `npm start`

## Live Deployment Installation

See [DEPLOY.md](documentation/DEPLOY.md)

# Contributing

- Use two space indents.
- Name files in camelCase.

# Credits

* [**Marzavec**](https://github.com/marzavec) - *Initial work*
* [**MinusGix**](https://github.com/MinusGix) - *Base updates*
* [**Neel Kamath**](https://github.com/neelkamath) - *Base Documentation*
* [**Carlos Villavicencio**](https://github.com/po5i) - *Syntax Highlighting Integration*
* [**OpSimple**](https://github.com/OpSimple) - *Modules Added: dumb.js & speak.js*
* [**Andrew Belt**](https://github.com/AndrewBelt), for original base work
* [**wwandrew**](https://github.com/wwandrew), for finding server flaws (including attack vectors) and submitting ~~___incredibly detailed___~~ bug reports
* [**Everyone else**](https://github.com/hack-chat/main/graphs/contributors) who participated in this project.

# License

This project is licensed under the [MIT License](LICENSE).
Again again 2018-05-18 00:34:50 +08:00			`# hack.chat`
better documentation 2018-04-09 11:01:44 +08:00
streamline dev flow 2018-05-20 08:21:08 +08:00			`[hack.chat](https://hack.chat/) is a minimal, distraction-free, accountless, logless, disappearing chat service which is easily deployable as your own service. The current client comes bundled with LaTeX rendering provided by [KaTeX](https://github.com/Khan/KaTeX) and code syntax highlighting provided by [highlight.js](https://github.com/isagalaev/highlight.js).`
initial commit 2018-03-10 15:47:00 +08:00
Again again 2018-05-18 00:34:50 +08:00			`A list of software developed for the hack.chat framework can be found at the [3rd party software list](https://github.com/hack-chat/3rd-party-software-list) repository. This includes bots, clients, docker containers, etc.`
added software link to readme 2018-04-19 23:34:58 +08:00
Latest dev sync 2022-06-23 00:32:51 +08:00			`This is a backwards compatible continuation of the [work by Andrew Belt](https://github.com/AndrewBelt/hack.chat). The server code has been updated to ES6 along with several new features including new commands and hot-reload of the commands/protocol. There is also [documentation](documentation/index.html).`
initial commit 2018-03-10 15:47:00 +08:00
Again again 2018-05-18 00:34:50 +08:00			`# Installation`
initial commit 2018-03-10 15:47:00 +08:00
Again again 2018-05-18 00:34:50 +08:00			`## Prerequisites`
initial commit 2018-03-10 15:47:00 +08:00
Latest dev sync 2022-06-23 00:32:51 +08:00			`- [node.js v16.14.0](https://nodejs.org/) or higher`
			`- [npm 8.5.4](https://nodejs.org/) or higher`
initial commit 2018-03-10 15:47:00 +08:00
streamline dev flow 2018-05-20 08:21:08 +08:00			`## Developer Installation`
initial commit 2018-03-10 15:47:00 +08:00
Again again 2018-05-18 00:34:50 +08:00			1. [Clone](https://help.github.com/articles/cloning-a-repository/) the repository: `git clone https://github.com/hack-chat/main.git`
			1. Change the directory: `cd main`
npm has been pkged with node for awhile now; we neednt list every pkg manager as tehy will know how to use their prefferred 2018-05-18 14:23:14 +08:00			1. Install the dependencies: `npm install`
streamline dev flow 2018-05-20 08:21:08 +08:00			1. Launch: `npm start`
initial commit 2018-03-10 15:47:00 +08:00
formatting fix 2018-05-20 09:10:04 +08:00			`## Live Deployment Installation`
initial commit 2018-03-10 15:47:00 +08:00
streamline dev flow 2018-05-20 08:21:08 +08:00			`See [DEPLOY.md](documentation/DEPLOY.md)`
Document 2018-05-12 00:00:27 +08:00
Again again 2018-05-18 00:34:50 +08:00			`# Contributing`
Document 2018-05-12 00:00:27 +08:00
Again again 2018-05-18 00:34:50 +08:00			`- Use two space indents.`
			`- Name files in camelCase.`
Document 2018-05-12 00:00:27 +08:00
Again again 2018-05-18 00:34:50 +08:00			`# Credits`
initial commit 2018-03-10 15:47:00 +08:00
Again again 2018-05-18 00:34:50 +08:00			`* [Marzavec](https://github.com/marzavec) - Initial work`
			`* [MinusGix](https://github.com/MinusGix) - Base updates`
streamline dev flow 2018-05-20 08:21:08 +08:00			`* [Neel Kamath](https://github.com/neelkamath) - Base Documentation`
			`* [Carlos Villavicencio](https://github.com/po5i) - Syntax Highlighting Integration`
Completed protocol decoupling 2018-06-04 02:08:35 +08:00			`* [OpSimple](https://github.com/OpSimple) - Modules Added: dumb.js & speak.js`
Latest dev sync 2022-06-23 00:32:51 +08:00			`* [Andrew Belt](https://github.com/AndrewBelt), for original base work`
			`* [wwandrew](https://github.com/wwandrew), for finding server flaws (including attack vectors) and submitting ~~___incredibly detailed___~~ bug reports`
			`* [Everyone else](https://github.com/hack-chat/main/graphs/contributors) who participated in this project.`
Enhance READM.md 2018-05-12 17:19:56 +08:00
Again again 2018-05-18 00:34:50 +08:00			`# License`
Enhance READM.md 2018-05-12 17:19:56 +08:00
Latest dev sync 2022-06-23 00:32:51 +08:00			`This project is licensed under the [MIT License](LICENSE).`