processing-boilerplate

This setup lets you develop Processing applications (using processing.js) in any editor without having to use or install the Processing IDE.

It also comes with handy features like a built-in webserver, automatic builds on file save and livereloading.

##Prerequisites## You need to have node.js (>=0.10.5) installed. A global installation of the CLI version of Grunt (>=0.4.0) is also required, but this will auto-install itself if it is not found on your machine.

##Installation## Clone the repo using git (or download and unzip the repo inside a new folder):

$ git clone git://github.com/m90/processing-boilerplate.git

Navigate to the repository's root and install all dependencies:

$ npm install

This should also install grunt-cli globally if it is not present on your system, but apparently there's no solution that works 100% reliably on all OSes and shells, so if you are having trouble running the boilerplate you may still need to check this manually and install grunt-cli globally like:

$ npm list grunt-cli -g
$ npm install grunt-cli -g

If you want to, edit the information in the package.json file to suit your sketch's needs.

##Workflow## In the repo's root folder, start Grunt's default task:

$ grunt

This will fire up a static server serving a JavaScript version of your processing sketch to localhost:9001 (if you want access this from other machines use 192.168.x.xxx:9001 using your server's local IP). To end this process just hit Ctrl + C and you're done.

Work and develop inside the sketch directory and Grunt will listen for all changes inside this folder. Each time you change a file a new version of your sketch is rendered and "deployed". If your browser supports WebSockets the sketch will automatically reload, in case not: just hit reload yourself. ###Command line options### You can use another port for your webserver by using the port option like:

$ grunt --port=1337

You can turn off livereloading by using the no-livereload flag like:

$ grunt --no-livereload

If you want the system to render a "less fancy" version of the webpage (just the canvas element and nothing else) you can use the naked flag:

$ grunt --naked

###External libraries### If you need to include external libraries/APIs just place the .js file in the sketch folder, the build system will copy them into the build folder and include them into the final HTML. ###Assets### Place assets like sound or images inside a data folder inside your sketch folder, they will also be copied by the system.

---

###License & Copyright### (c) 2013 Frederik Ring - Released under the MIT License