From a70006b5bca3c3273ba34bfd0607235339e87583 Mon Sep 17 00:00:00 2001 From: marzavec Date: Sat, 19 May 2018 17:21:08 -0700 Subject: streamline dev flow --- README.md | 28 +++++++++++++--------------- 1 file changed, 13 insertions(+), 15 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 91c6fed..dc32535 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,35 @@ # 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 client comes bundled with LaTeX rendering provided by [KaTeX](https://github.com/Khan/KaTeX). +[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.md) and a [changelog](CHANGELOG.md). +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/DOCUMENTATION.md) and a [changelog](CHANGELOG.md). # Installation ## Prerequisites - [node.js 8.10.0](https://nodejs.org/en/download/package-manager/#windows) or higher +- [npm 5.7.1](https://nodejs.org/en/download/package-manager/#windows) or higher -## Installing +## 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. Configure: `npm start` +1. Launch: `npm start` - If you change the `websocketPort` option during the config setup then these changes will need to be reflected on [line 59 of client.js](https://github.com/hack-chat/main/blob/master/client/client.js#L59). + If you change the `websocketPort` option during the config setup then these changes will need to be reflected on [line 60 of client.js](https://github.com/hack-chat/main/blob/master/client/client.js#L60). -# Usage +# Live Deployment Installation -1. `cd` into the repository: `cd main` -1. Start the server: `npm start` with a process manager. -1. Launch: `client/index.html` -1. (OPTIONAL) If you want to deploy your hack.chat instance to a server, push everything except the `node_modules` directory and install the dependencies (`npm install`). - - You can now run start the server software with a process manager like [PM2](https://github.com/Unitech/pm2) (e.g., `pm2 start server/main.js --name HackChat`). 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). +See [DEPLOY.md](documentation/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](templateCommand.js) to learn how to create new commands. +- Use [the template](documentation/templateCommand.js) 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. @@ -42,8 +38,10 @@ This is a backwards compatible continuation of the [work by Andrew Belt](https:/ * [**Marzavec**](https://github.com/marzavec) - *Initial work* * [**MinusGix**](https://github.com/MinusGix) - *Base updates* -* Andrew Belt, https://github.com/AndrewBelt/hack.chat, for original base work -* [wwandrew](https://github.com/wwandrew/), for finding server flaws (including attack vectors) and submitting ~~___incredibly detailed___~~ bug reports +* [**Neel Kamath**](https://github.com/neelkamath) - *Base Documentation* +* [**Carlos Villavicencio**](https://github.com/po5i) - *Syntax Highlighting Integration* +* 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 -- cgit v1.2.1