StarMirror/hack-chat-main
1
0
Fork 0
mirror of https://github.com/hack-chat/main.git synced 2024-03-22 13:20:33 +08:00
Code Issues Projects Releases Wiki Activity
a minimal, distraction-free chat application
68 Commits 2 Branches 0 Tags 9.6 MiB
JavaScript 90.3%
CSS 9%
HTML 0.7%
b928d30d59
Go to file
marzavec b928d30d59
Merge pull request #17 from OpSimple/patch-1 
Let visitors know about the other softwares
2018-06-07 06:35:26 -07:00
client shortened the url for other softwares 2018-06-07 19:02:23 +05:30
clientSource cleaned up and commented modules 2018-06-04 00:07:24 -07:00
documentation Update DOCUMENTATION.md 2018-06-01 01:51:51 +05:30
server cleaned up and commented modules 2018-06-04 00:07:24 -07:00
.gitignore Flatten 2018-05-13 16:09:55 +05:30
CHANGELOG.md Completed protocol decoupling 2018-06-03 11:08:35 -07:00
index.js streamline dev flow 2018-05-19 17:21:08 -07:00
LICENSE Add license as a file in the repo as GitHub's documentation 2018-05-11 19:33:08 +05:30
package-lock.json cleaned up and commented modules 2018-06-04 00:07:24 -07:00
package.json Completed protocol decoupling 2018-06-03 11:08:35 -07:00
README.md Completed protocol decoupling 2018-06-03 11:08:35 -07:00

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 and a changelog.

Installation

Prerequisites

Developer Installation

  1. Clone the repository: git clone https://github.com/hack-chat/main.git

  2. Change the directory: cd main

  3. Install the dependencies: npm install

  4. Launch: npm start

    If you change the websocketPort option during the config setup then these changes will need to be reflected on line 60 of client.js.

Live Deployment Installation

See DEPLOY.md

Contributing

  • If you are modifying commands, make sure it is backwards compatible with the legacy client and you update the documentation accordingly.
  • Use the template to learn how to create new commands.
  • Use two space indents.
  • Name files in camelCase.
  • Scripts that do not default to strict mode (such as modules) must use the 'use strict' directive.

Credits

License

This project is licensed under the WTFPL License.