pipeline-builder/README.md

Pipeline Builder

[![Build Status](https://travis-ci.org/epam/pipeline-builder.svg?branch=master)](https://travis-ci.org/epam/pipeline-builder)
[![Coverage Status](https://coveralls.io/repos/github/epam/pipeline-builder/badge.svg?branch=dev)](https://coveralls.io/github/epam/pipeline-builder?branch=dev)

# Pipeline Builder

Pipeline Builder is a JavaScript library for visualizing and constructing bioinformatics workflows, using  Workflow Description Language (WDL)

* Visualization of WDL scripts [https://github.com/broadinstitute/wdl](https://github.com/broadinstitute/wdl)
* Visual editor for creation and customization of a bioinformatics workflow, composed from a set of tools
* Generation of a WDL (Workflow Definition Language) script for the workflow
* Integration API into on-premises and cloud workflow environments

![general-view](docs/general/images/pb-overview.png)

## Demo environment

Example of a **Pipeline Builder** usage is available at [http://pb.opensource.epam.com](http://pb.opensource.epam.com) built on master branch and 
[http://pb.opensource.epam.com:10000](http://pb.opensource.epam.com:10000) built on dev branch

This demo application demonstrates major capabilities of a **Pipeline Builder**

Description of the demo application is available at [Demo application overview](docs/general/README.md)

## Installation and Usage

Install `pipeline-builder` the usual way:

```sh
npm install --save pipeline-builder
```

Then require it

```js
const pipeline = require('pipeline-builder');
console.log(pipeline.VERSION);
```

Refer to the [API docs and tutorials](docs/tutorials) for more details

## WDL Parser/Visualizer limitations

The following WDL features, that require more specific parsing or visualization, are not supported at the moment:

* [Imports](https://github.com/broadinstitute/wdl/blob/develop/SPEC.md#import-statements)
* [Sub workflows](https://github.com/broadinstitute/wdl/blob/develop/SPEC.md#sub-workflows)
* [Order of steps (workflow, call, if, scatter, while) in generated WDL code](https://github.com/broadinstitute/wdl/blob/develop/SPEC.md#workflow-level-resolution)
* [Declarations in a [call, if, scatter and while] blocks are not supported](https://github.com/broadinstitute/wdl/blob/develop/SPEC.md#conditionals)

## Contribution

Ensure that the latest [git](https://git-scm.com/)
(e.g [Git For Windows](https://git-for-windows.github.io/)) and
[Node.js v6 LTS](https://nodejs.org/) are installed. You're also encouraged to use
[Yarn](https://yarnpkg.com/) package manager to guarantee that package versions are consistent across
all build machines.
[Gulp.js v3](http://gulpjs.com/) is used as a build framework.

```sh
# grab the project
git clone https://github.com/epam/pipeline-builder.git

# install necessary Node.js modules
cd pipeline-builder
yarn global add gulp-cli
yarn install

# test and build everything
gulp

# or just start webpack development server with live reload
gulp serve
```