From dbc4bac6a22cea2cf90625ba41f587113f0edbb1 Mon Sep 17 00:00:00 2001 From: Adam Brown Date: Thu, 3 Nov 2016 18:52:09 -0400 Subject: [PATCH] update readme --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/README.md b/README.md index 105d9ee..04d2671 100644 --- a/README.md +++ b/README.md @@ -10,3 +10,35 @@ The markdown-sensitive processing of the wdiff comparison is at `server/componen ## Live Version The tool is live at http://dubdiff.com, feel free to use it there. + +## Provisioning + +You'll need the following: + - node & npm + - grunt and bower (`npm install -g grunt bower`) + - ruby (`apt install ruby`) + - sass (`gem install sass`) + - wdiff (`apt install wdiff`) + +The wdiff binary should be placed in the `bin` subfolder, or a link should be made to the binary. Eg. `ln -s /usr/bin/wdiff bin/wdiff`. + + npm install && bower install + mkdir data + +### Low-memory environments + +On a low-memory machine, eg. a DigitalOcean 512MB instance, you will need to enable virtual memory. Use this guide: + + - [https://www.digitalocean.com/community/tutorials/how-to-configure-virtual-memory-swap-file-on-a-vps#2] + +### Start on boot + + +To make the application start on boot, run the following: + + pm2 start grunt --name dubdiff -- serve:dist + pm2 startup systemd + pm2 save + +[Digital Ocean: How To Set Up a Node.js Application for Production on Ubuntu 16.04](https://www.digitalocean.com/community/tutorials/how-to-set-up-a-node-js-application-for-production-on-ubuntu-16-04) +