diff options
| author | Neel Kamath <neelkamath@pop-os.localdomain> | 2018-05-18 08:23:14 +0200 |
|---|---|---|
| committer | Neel Kamath <neelkamath@pop-os.localdomain> | 2018-05-18 08:23:14 +0200 |
| commit | 775fb26a245a6d16f136a107da9ab20fb2613c4f (patch) | |
| tree | 26d944fa1f36480264b7790aef5285393e97fcdd /README.md | |
| parent | Check "main" and "scripts/start" (diff) | |
| download | hackchat-775fb26a245a6d16f136a107da9ab20fb2613c4f.tar.gz hackchat-775fb26a245a6d16f136a107da9ab20fb2613c4f.zip | |
npm has been pkged with node for awhile now; we neednt list every pkg manager as tehy will know how to use their prefferred
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 14 |
1 files changed, 5 insertions, 9 deletions
@@ -16,23 +16,19 @@ This is a backwards compatible continuation of the [work by Andrew Belt](https:/ 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 using a package manager of your choice: - - npm: `npm install` - - yarn: `yarn install` -1. Configure: `node server/main.js` +1. Install the dependencies: `npm install` +1. Configure: `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). # Usage 1. `cd` into the repository: `cd main` -1. Start the server with a process manager. For example, with [PM2](https://github.com/Unitech/pm2): `pm2 start server/main.js --name HackChat` +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 using a package manager of your choice: - - npm: `npm install` - - yarn: `yarn install` +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. 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). + 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). # Contributing |