diff options
| author | Neel Kamath <neelkamath@protonmail.com> | 2018-05-13 12:39:55 +0200 |
|---|---|---|
| committer | Neel Kamath <neelkamath@protonmail.com> | 2018-05-13 12:39:55 +0200 |
| commit | 2bb5ced363b692a5696b176bc317fe525c0c05df (patch) | |
| tree | 1532d9456c5f2b25ac05f7cec620a3af890eff83 /README.md | |
| parent | Re-add module documentation (diff) | |
| download | hackchat-2bb5ced363b692a5696b176bc317fe525c0c05df.tar.gz hackchat-2bb5ced363b692a5696b176bc317fe525c0c05df.zip | |
Flatten
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 8 |
1 files changed, 3 insertions, 5 deletions
@@ -15,18 +15,16 @@ This is a backwards compatible continuation of the [work by Andrew Belt](https:/ ## Installing 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/server` 1. Install the dependencies using a package manager of your choice: - npm: `npm install` - yarn: `yarn install` -1. Configure: `node main.js` +1. Configure: `node main/server/main.js` - If you change the `websocketPort` option during the config setup then these changes will need to be reflected on [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 59 of client.js](https://github.com/hack-chat/main/blob/master/client/client.js#L59). # Usage -1. Change the directory: `cd main/server/` -1. Start the server with a process manager. For example, with [PM2](https://github.com/Unitech/pm2): `pm2 start main.js --name HackChat` +1. Start the server with a process manager. For example, with [PM2](https://github.com/Unitech/pm2): `pm2 start main/server/main.js --name HackChat` 1. Launch: `main/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 using a package manager of your choice: - npm: `npm install` |