##Installation

You can install and run an instance of Palladio on your local machine, following these instructions.

Clone Palladio by using the GitHub app for Mac or Windows or from the command line:

$ git clone git://github.com/humanitiesplusdesign/palladio.git

Since Palladio uses some server-side functionalities, you need to run Palladio from a local web server (i.e. it is NOT enough to open the apps/palladio/index.html file in the browser!). This can be easily done on both Mac, Linux or Windows machines. For example, you can run Python's built-in server within the Palladio directory.

From the command line, browse to Palladio root folder:

$ cd palladio

Run Python 2 server:

$ python -m SimpleHTTPServer

or for Python 3+

$ python -m http.server

Once this is running, go to http://localhost:8000/apps/palladio.

Alternatively, if you have Node.js and NPM installed, you can use the development toolchain to run Palladio.

If you don't already have it, install gulp and bower

$ npm install -g gulp
$ npm install -g bower

From the Palladio root folder, install dependencies:

$ npm install
$ bower install

Then run gulp, which will launch a webserver on port 8000. If you get an error, make sure you don't have any other servers running.

$ gulp

Once this is running, go to http://localhost:8000/.

Use Ctrl-C to stop the server.

Development

Generally, update files in the /src directory, not the palladio.js/palladio.css files in the root directory or in the apps directories. When running, Gulp will automatically detect changes in the /src directory and update the compiled Palladio files as required.

Running tests

Test coverage in Palladio is not great at the moment, but there are tests covering much of the functionality in the various services that Palladio defines. We're working on improving coverage to the rest of the framework.

From the command line at the root directory run:

karma start ./test/karma.conf.js

If you don't have karma installed, you may need to install it first:

npm install -g karma