diff options
| author | Neel Kamath <neelkamath@protonmail.com> | 2018-05-13 12:10:43 +0200 |
|---|---|---|
| committer | Neel Kamath <neelkamath@protonmail.com> | 2018-05-13 12:10:43 +0200 |
| commit | 89698d8afb069a6e5c20849411bd5e2e6cf8acad (patch) | |
| tree | 4994e0243e7e171bef15c78eaceba9b85e3e35ba | |
| parent | Enhance READM.md (diff) | |
| download | hackchat-89698d8afb069a6e5c20849411bd5e2e6cf8acad.tar.gz hackchat-89698d8afb069a6e5c20849411bd5e2e6cf8acad.zip | |
Make PM2 optional
| -rw-r--r-- | README.md | 13 | ||||
| -rw-r--r-- | server/package.json | 3 |
2 files changed, 5 insertions, 11 deletions
@@ -25,17 +25,14 @@ This is a backwards compatible continuation of the [work by Andrew Belt](https:/ # Usage -1. Start the server: - ``` - cd main/server/ - pm2 start main.js --name HackChat - ``` -1. Launch `main/client/index.html`, you may now begin development or deploy to production environment. -1. (Optional) Deploy by pushing everything (except the `node_modules` directory) to the server and install the dependencies using the package manager of your choice: +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. 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` - yarn: `yarn install` - You can now run start the server software with a process manager like [PM2](https://github.com/Unitech/pm2). 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. 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 diff --git a/server/package.json b/server/package.json index f1ea460..8417c13 100644 --- a/server/package.json +++ b/server/package.json @@ -30,8 +30,5 @@ "prompt": "^1.0.0", "readdir-recursive": "0.0.4", "ws": "^5.0.0" - }, - "devDependencies": { - "pm2": "^2.10.3" } } |