Streamflow Webclient

Important: As of 2015-02-19 the webclient was broken off into its own repository, meaning previous history will be erased. If you need someone to git-blame for something in particular, previous history will be available in the core repository, starting at this commit.

Getting Started

GUI Submodule

This project has its CSS stored in a submodule. Do the following:

git submodule update --init
cd app/design
git checkout develop

Install Dependencies & Build

External dependencies are installed via npm and bower. Lastly gulp will handle the build process (minification, uglification, etc.).

cd ~/path/to/streamflow-webclient
git checkout develop
npm install
bower install
gulp

The built application ends up in the build/ directory and is served on localhost:9999 (go ahead, click it!).

Running Tests

Tests can be run with the following commands:

gulp unit-test
gulp e2e-test

Deployment

Maven is used to build the complete project. It can be downloaded from here or installed via Homebrew (Mac):

brew install maven

Make sure you have all the latest changes.

In the root directory type:

mvn clean install

The build process should start and will create a .war file in the target/ directory.

Coding Conventions

Good looking code is important. Keep jshint happy, and try to follow these simple rules:

• End files with a newline (but why?!).

• Use whitespaces to increase legibility:

  // Do
  addFunc(function (val) {
    return val + val;
  });
  
  // Don't
  addFunc(function(val){
    return val+val;
  });

• Don't leave behind console.log or debugger statements.

• Don't commit half-finished implementations.

• Don't repeat yourself (DRY).