Skip to content

Compiling Datavyu

Jesse Lingeman edited this page Mar 31, 2017 · 4 revisions

Introduction

This guide steps new developers and the curious through the process of obtaining and compiling the Datavyu source code.

Steps for the impatient

To run datavyu:

git clone https://github.com/databrary/datavyu.git
cd datavyu
export MAVEN_OPTS="-Xmx256M"
mvn -Prelease,jar-package -Dmaven.test.skip=true jfx:run

To build the native packages

mvn -Prelease,jar-package -Dmaven.test.skip=true jfx:native

Requirements

To get started you will need to download and install a few development tools. Datavyu is primarily written in Java, and the scripting engine is powered by Ruby (via JRuby). The list of toys you will need to download:

  • IntelliJ IDEA or your IDE of choice. IntelliJ project file is included.
  • JDK 1.8 (32-bit for Windows, 64-bit for OSX)
  • Maven
  • Git

IntelliJ Project

You should be able to just open the IntelliJ IDEA project included with the source code. However, if that does not work, import the folder as a new project, and create a new Maven Run/Debug configuration with the command line parameters "-Dmaven.test.skip=true jfx:run". This will allow you to run Datavyu from the IDE.

Configure git

In order for git to correctly populate Datavyu's version history of any changes that you contribute, the following configuration commands need to be issued:

git config --global user.name "your name"
git config --global user.email your_email@address.com

Getting the source code

We use git to track versioning changes of Datavyu; it is a distributed version control system so it’s a little different from CVS or SVN (this excellent guide maps concepts from SVN to Git). If you are new to Git, check out the documentation here and our git cheat sheet to get you going. But basically a single command is used to ‘checkout’ datavyu:

git clone https://github.com/Datavyu/datavyu.git

Compiling Datavyu

The above step should create an datavyu directory move into this directory and use maven to invoke the build:

cd datavyu
export MAVEN_OPTS="-Xmx256M"
mvn -Prelease,jar-package -Dmaven.test.skip=true jfx:native

The native files will be located in the target/jfx folder.

Clone this wiki locally