Initial setup

If you are going to make changes on the project you will probably need to run ParticleQuest locally. In this page are gathered all steps to get it working.

Installation

1. Clone the repository.
2. Make sure you have Node.js and npm installed. http://nodejs.org/#download
3. Install the dependencies listed in package.json. They can be installed running from the top level directory: $ npm install -d

Running the server

1. Edit /server/config.json to reflect the port on which the server will run. 8000 will work just fine.
2. Leave "metrics_enabled": false. Otherwise you would get the error: ERROR uncaughtException: Error: connect ECONNREFUSED.
3. Run from the top level directory: $ node server/js/main.js

Running the client

1. Go to /client/config/
2. $ cp config_build.json-dist config_build.json, edit for correct host:port. Eg. "127.0.0.1" (in quotes) and 8000 (not in quotes) (*)
3. $ cp config_local.json-dist config_local.json, edit for correct host:port. Eg. "127.0.0.1" (in quotes) and 8000 (not in quotes) (*)
4. Start an http server in the /client/ directory. Eg. to use python's build in http server, type: $ python -m SimpleHTTPServer 8080
5. Finally visit localhost:client_port (eg. http://localhost:8080) from your browser to view index.html.

• (*) Host needs to be an IP or domain (**). Eg. for localhost, you need to use "127.0.0.1". "localhost" caused an error connecting to the server.
• (**) If you have a proper domain, don't prefix it with http:// - Eg. particlequest.com, not http://particlequest.com.