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
33 Commits 2 Branches 0 Tags 9.6 MiB
JavaScript 90.3%
CSS 9%
HTML 0.7%
343157350f
Go to file
Neel Kamath 343157350f Re-add module documentation
2018-05-13 16:03:22 +05:30
client misc server changes and new modules 2018-04-28 22:29:46 -07:00
server Re-add module documentation 2018-05-13 16:03:22 +05:30
CHANGELOG.md misc server changes and new modules 2018-04-28 22:29:46 -07:00
DOCUMENTATION.md Re-add module documentation 2018-05-13 16:03:22 +05:30
LICENSE Add license as a file in the repo as GitHub's documentation 2018-05-11 19:33:08 +05:30
README.md Use the 'use strict' directive when needed 2018-05-13 15:48:46 +05:30
templateCommand.js Enhance READM.md 2018-05-12 14:49:56 +05:30

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 client comes bundled with LaTeX rendering provided by KaTeX.

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

Installing

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

  2. Change the directory: cd main/server

  3. Install the dependencies using a package manager of your choice:

    • npm: npm install
    • yarn: yarn install

  4. Configure: node main.js

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

Usage

  1. Change the directory: cd main/server/

  2. Start the server with a process manager. For example, with PM2: pm2 start main.js --name HackChat

  3. Launch: main/client/index.html

  4. (OPTIONAL) If you want to deploy your hack.chat instance to a server, push everything except the node_modules directory and install the dependencies using a package manager of your choice:

    • npm: npm install
    • yarn: yarn install

    You can now run start the server software with a process manager. The client code will need to be copied into your http server directory. If you plan on using SSL to serve the client; you will need to use a reverse proxy, as TLS is not natively supported by the hack.chat server software (this may change in future releases).

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.