WebVOWL

This repository was ported from an internal SVN repository to Github after the release of WebVOWL 0.4.0. Due to cleanups with git filter-branch, the commit history might show some strange effects.

Run Using Docker

Make sure you are inside WebVOWL directory and you have docker installed. Run the following command to build the docker image:

docker build . -t webvowl:v1

Run the following command to run WebVOWL at port 8080.

docker-compose up -d

Visit http://localhost:8080 to use WebVOWL.

Requirements

Node.js for installing the development tools and dependencies.

Development setup

Simple

1. Download and install Node.js from http://nodejs.org/download/
2. Open the terminal in the root directory
3. Run npm install to install the dependencies and build the project
4. Edit the code
5. Run npm run-script release to (re-)build all necessary files into the deploy directory
6. Run serve deploy/ to run the server locally, by installing serve by using npm install serve -g.

Visit http://localhost:3000 to use WebVOWL.

Advanced

Instead of the last step of the simple setup, install the npm package grunt-cli globally with npm install grunt-cli -g. Now you can execute a few more advanced commands in the terminal:

• grunt or grunt release builds the release files into the deploy directory
• grunt package builds the development version
• grunt webserver starts a local live-updating webserver with the current development version
• grunt test starts the test runner
• grunt zip builds the project and puts it into a zip file

Additional information

To export the VOWL visualization to an SVG image, all css styles have to be included into the SVG code. This means that if you change the CSS code in the vowl.css file, you also have to update the code that inlines the styles - otherwise the exported SVG will not look the same as the displayed graph.

The tool which creates the code that inlines the styles can be found in the util directory. Please follow the instructions in its README file.