Get Started

Start your development...

The following page shows all the basics in order to get started with the VALID development. It will list all the requirements and shows the basic framework we are using as well as the installation and how to update. Furthermore the most important system settings and programs are explained here from scratch. This is a more beginner orientated guide. If you are familar with node, frameworks and PyCharm, head to the front page of this repository --> Quick Start.

NOTE: All requirements and installations are described for the following platforms:

• Windows
• Mac OSX
• Linux

If not explicitly hinted or labled, the requirement or process is equal for all three platforms.

Requirements

Node.js

1. Fist of all you need to install Node.js and along side the npm (Node Package Manager). Download the latest version of Node.js here Node.js Download and use the installer.
2. If you have Node.js already installed, please check that you have the minimal version required v6.9.1. You can check which version you have by opening a command prompt and type node -v. If your version is older, please update the node version.
3. To update node, it's recommended to use the nvm (Node Version Manager), which can be found under the following link Node Version Manager along all installation instructions.

Special guide for Mac OSX: Guide NVM Mac

Git Bash && || GUI

In order to pull the repository to your local machine, you need Git. It's best to install the Git GUI, which comes with a handful of great tools and visual browsing for branches. Download the installer for your platform and follow the instructions on the official site Git GUI Installation. After the installer finished, you should have Git installed globally and also the Git Bash available, which looks like this:

IDE - Development Environment

• The prefered Development environment, which this project is configured for is PyCharm, which can be downloaded here: PyCharm The IDE inlcudes the TypeScript compiler as well as the SCSS compiler and other handy features like the VCS (Version Control) with Git.
• Alternatively you can use Sublime for example.
• Or you use Atom, but please note that the project isn't specifically configured for other IDEs except PyCharm.

Framework specific

In order to make updates to the framework behind, you will need the two basic systems that the Phovea framework relies on. The first you should install is Yeoman, which is basically a build tool. Install it with the following command from your command line tool (no matter where):

npm install -g yo

Next you need the Phovea-Generator, which is used for updating the framework if needed. Install it by executing the following command in your commandline tool (no matter where):

npm install -g github:phovea/generator-phovea

For Mac OSX or Linux you might need to use sudo.

Installation

Now it's time to install the latest version of DyNetFlowVis locally on your machine to start coding. Before you start don't forget to head over to the other guides and read how you can contribute and interact with this repository.

• For the installation open your Git Bash or Terminal and execute the following statements:

 git clone https://github.com/VALIDproject/DyNetFlowVis.git
 cd DyNetFlowVis
 npm install

!! This will clone the repository valid to your current location, where you are in your command line. Preferably it should be your root path, e.g. for Windows it's C:\ !!

Hint: If npm install has error messages or is not doing much, change your WIFI connection or maybe some of your ports are blocked.

• Next open up PyCharm or your Editor and open the Project. Then right-click on the package.json, which is located in the root folder of the project and select show npm scripts. This will bring up a list of scripts that are handy to test or start the project and to build it once it's finished.

Updates to framework

As we rely on a framework for easy development and advanced coding facilities, it's sometimes needed to update the framework. You don't need to to this specifically but only from time to time or if you are notified. The first command updates the workspace or plugin you are currently working with (for this repository it updates DyNetFlowVis):

yo phovea:update

• To update all repositories and all dependencies there is a forEach.cmd, which can be executed from the command line on Windows.
• For Mac OSX and Linux users exists a forEach file, which has to be made executable Make File Executable.

--> NEXT PAGE