Complete README with Supervisor, Cordova, Unit Testing instructions

Author: Lionel Laské

README.md

@@ -23,18 +23,24 @@ Features of Sugarizer Thin Client include:
 * Backup or sharing of local storage content to the Server,
 * Presence and collaboration
 
-Note: You can run sugarizer from the link above, but the Thin Client access is provided by all the Sugarizer Servers, so you can use others as well. 
+Note: You can run sugarizer from the link above, but the Thin Client access is provided by all the Sugarizer Servers, so you can use for your own Sugarizer Server. See below how to install your own Sugarizer Server. 
 
 # Client
 
-Sugarizer Client is Sugarizer installed locally on the device so it does not require any access to the Server - it works stand-alone. Server access could be required only when it needs network features. Sugarizer could work on any device with a recent Chrome/Chromium version and has also been tested successfully on Firefox, Safari and IE. Sugarizer Client is available for PC, for Android, iOS, Chrome Web App and for Firefox OS devices.
+Sugarizer Client is Sugarizer installed locally on the device so it does not require any access to the Server - it works stand-alone. Server access could be required only when it needs network features. Sugarizer could work on any device with a recent Chrome/Chromium version and has also been tested successfully on Firefox, Safari and IE. Sugarizer Client is available for PC, for Android, iOS and Chrome Web App.
 
-To run Sugarizer on your PC (GNU Linux/Mac OS/Windows), launch Chrome using the command line:
+To run **Sugarizer on your PC** (GNU Linux/Mac OS/Windows), launch Chrome using the command line:
 
     chrome --allow-file-access-from-files
 
 Then open the "index.html" file in the browser. Note that the option "--allow-file-access-from-files" is needed to authorize access to local file. Don't forget to close all other instances of Chrome before using this option. For other browser equivalent options see [here](https://github.com/mrdoob/three.js/wiki/How-to-run-things-locally "here"). Do not hesitate to write a shortcut on this command for future use.
 
+To run **Sugarizer Client on Android**, download it on [Google Play](https://play.google.com/store/apps/details?id=org.olpc_france.sugarizer), [Amazon Store](http://www.amazon.com/gp/product/B00NKK7PZA) or [F-Droid](https://f-droid.org/repository/browse/?fdid=org.olpc_france.sugarizer). You could also build yourself the Sugarizer Client APK using instruction below.
+
+To run **Sugarizer Client on iOS**, download it on [Apple Store](https://itunes.apple.com/us/app/sugarizer/id978495303) or build yourself the Sugarizer Client IPA using instructions below.
+
+To run **Sugarizer Client as Chrome Web App**, download it on [Chrome Web Store](https://chrome.google.com/webstore/detail/sugarizer/omfgclgehghdlloggibhgicnlldjiboo) or use the [Chrome Apps & Extensions Developer Tool](https://chrome.google.com/webstore/detail/chrome-apps-extensions-de/ohmmkhmmmpcnpikjeljgnaoabkaalbgc) and use the Sugarizer directory as target for unpacked application.
+
 Features of Sugarizer Client include:
 
 * Sugar Desktop view (Radial, List and Journal),
@@ -68,14 +74,7 @@ To run your own Sugarizer Server, follow the step behind. Commands are shown fro
 
 **Install Node.js**: Install Node.js and npm to manage packages. See [here](http://nodejs.org/ "here") more information.
 
-    sudo apt-get install python g++ make checkinstall fakeroot
-    src=$(mktemp -d) && cd $src
-    wget -N http://nodejs.org/dist/node-latest.tar.gz
-    tar xzvf node-latest.tar.gz && cd node-v*
-    ./configure
-    sudo fakeroot checkinstall -y --install=no --pkgversion $(echo $(pwd) | sed -n -re's/.+node-v(.+)$/\1/p') make -j$(($(nproc)+1)) install
-    sudo dpkg -i node_*
-    curl https://www.npmjs.org/install.sh | sudo sh
+    sudo apt-get install nodejs
 
 **Install MongoDB**: Don't forget to create a /data/db directory to store databases. See [here](http://www.mongodb.org/ "here") more information.
 
@@ -101,4 +100,106 @@ To run your own Sugarizer Server, follow the step behind. Commands are shown fro
     sudo iptables -A INPUT -i eth0 -p tcp --dport 8039 -j ACCEPT   # Presence 
     sudo iptables -A OUTPUT -p tcp --dport 8039 -j ACCEPT    # Presence
 
-To check your install, run "http://<server name>/sugarizer" in your browser: you should see the home with all activities. Then go to Journal view, you should see at the bottom of the screen the two icons to switch to private/shared journal.
+**Check your install**: To check your install, run "http://<server name>/sugarizer" in your browser: 
+
+* you should see the home with all activities,
+* go to Journal view, you should see at the bottom of the screen the two icons to switch to private/shared journal,
+* go to the neighborhood view, you should seen one icon for the server and one for you.
+
+You could also run unit tests (see below) to ensure that everything works.
+
+# Unit testing
+
+Sugarizer include a set of unit tests both for client side and for server side.
+To run unit tests, you should first install [Mocha](http://mochajs.org/):
+
+	sudo npm install -g mocha
+
+To run unit tests for Sugarizer Server, launch:
+
+	cd /var/www/sugarizer/server/
+	mocha
+
+To run unit tests for Sugarizer Client, run "file:///var/www/sugarizer/test/index.html" in your browser.
+
+# Supervise your Sugarizer Server
+
+Instead of running your Sugarizer Server like described in the "Run MongoDB and Sugarizer Server" section above, you could use a tool like [supervisor](http://supervisord.org/) to run it in background.
+
+First install, supervisor:
+
+	sudo apt-get install supervisor
+
+Then install the wait-for-mongo node tool:
+
+	sudo npm install -g wait-for-mongo
+
+Create a sugarizer.sh file in /home/root directory:
+
+	wait-for-mongo mongodb://127.0.0.1:27018/sugarizer 30000
+	cd /var/www/server
+	node sugarizer.js
+
+Create a sugarizer.conf setting file in /etc/supervisor/conf.d directory:
+
+	[supervisord]
+	nodaemon=true
+	
+	[program:mongod]
+	command=/usr/bin/mongod --port 27018 --logpath /home/root/mongo.log
+	priority=1
+	
+	[program:sugarizer]
+	command=sh /home/root/sugarizer.sh
+	priority=2
+	stdout_logfile=/home/root/sugarizer.log
+	stderr_logfile=/home/root/sugarizer.log
+	autostart=true
+	autorestart=true
+
+Run the supervisor daemon for the first time:
+
+	sudo /etc/init.d/supervisor start
+
+MongoDB and Sugarizer Server should now start automatically at startup and restart if fail.
+You could start it manually using:
+
+	sudo supervisorctl start sugarizer
+
+You could end it manually using:
+
+	sudo supervisorctl stop sugarizer
+
+
+# Build Sugarizer Client for Android or iOS
+
+Sugarizer Client could be packaged as an Android or iOS application using [Cordova](http://cordova.apache.org/).
+
+To build it, first install Cordova as described [here](http://cordova.apache.org/).
+
+Then create a directory for Sugarizer Cordova and put the content of the git repository in the www directory:
+
+	cordova create sugar-cordova
+	cd sugar-cordova
+	rm config.xml
+	git clone https://github.com/llaske/sugarizer.git www
+
+Add the platform you want to add (here Android) and all cordova plugin need:
+
+	cordova platform add android
+	cordova plugin add cordova-plugin-camera
+	cordova plugin add cordova-plugin-device-motion
+	cordova plugin add cordova-plugin-dialogs
+	cordova plugin add cordova-plugin-globalization
+	cordova plugin add cordova-plugin-network-information
+	cordova plugin add cordova-plugin-device
+	cordova plugin add cordova-plugin-media
+
+Replace the auto generated config.xml file by the Sugarizer one:
+
+	cp www/config.xml .
+
+Build the package:
+
+	cordova build android
+