mirror of
https://github.com/hack-chat/main.git
synced 2024-03-22 13:20:33 +08:00
a minimal, distraction-free chat application
| .github | ||
| channels | ||
| client | ||
| commands | ||
| documentation | ||
| scripts | ||
| test | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc.cjs | ||
| .gitattributes | ||
| .gitignore | ||
| .hcserver.json | ||
| .nycrc | ||
| jsdoc.json | ||
| main.mjs | ||
| package-lock.json | ||
| package.json | ||
| pm2.config.cjs | ||
| README.md | ||
hack.chat
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 and code syntax highlighting provided by highlight.js.
A list of software developed for the hack.chat framework can be found at the 3rd party software list repository. This includes bots, clients, docker containers, etc.
This is a backwards compatible continuation of the work by Andrew Belt. 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.
Installation
Prerequisites
- node.js v16.14.0 or higher
- npm 8.5.4 or higher
Developer Installation
- Clone the repository:
git clone https://github.com/hack-chat/main.git - Change the directory:
cd main - Install the dependencies:
npm install - Launch:
npm start
Live Deployment Installation
See DEPLOY.md
Contributing
- Use two space indents.
- Name files in camelCase.
Credits
- Marzavec - Initial work
- MinusGix - Base updates
- Neel Kamath - Base Documentation
- Carlos Villavicencio - Syntax Highlighting Integration
- OpSimple - Modules Added: dumb.js & speak.js
- Andrew Belt, for original base work
- wwandrew, for finding server flaws (including attack vectors) and submitting
incredibly detailedbug reports - Everyone else who participated in this project.
License
This project is licensed under the MIT License.