Open DICOMweb (ODW)

Software Development Environment Setup

This document describes the standard software development environment that is used by the development team for Open DICOMweb. It is also a useful starting point for programmers wishing to build software based on the ODW SDKs.

Open DICOMweb (ODW) software is developed using the Dart programming language. Dart is an open-source, scalable programming language, with robust libraries and runtime systems, for building web, server, and mobile apps. See dartlang.org for more information.

The ODW project repositories are hosted on GitHub at Open DICOMweb.

The ODW project uses the GitHub Flow workflow. is a lightweight, branch-based workflow that supports teams and projects where deployments are made regularly. This guide explains how and why GitHub Flow works.

If you are planning to do development using Open DICOMweb, We recommend using JetBrain's WebStorm as your editor (IDE).

Getting Started Overview

We recommend you do the following before getting started:

1. Install Java
2. Install Dart
3. Install Webstorm
4. Clone ODW Software Development Kit repository
5. Clone ODW Examples examples

Java Installation and Setup

1. Download and install Jave software. See https://java.com/en/download. See https://java.com/en/download/help for help with installing Java.

2. Add Java bin director to the System (if possible) or User environment "path" variable.

For example, set the following user environment variables:

JAVA_HOME : C:\Program Files\Java\jdk1.8.0_25
JDK_HOME  : %JAVA_HOME%
JRE_HOME  : %JAVA_HOME%\jre
CLASSPATH : .;%JAVA_HOME%\lib;%JAVA_HOME%\jre\lib
PATH      : your-unique-entries;%JAVA_HOME%\bin

Note: Make sure that the longish your-unique-entries does not contain any other references to another Java installation folder.

Dart Installation and Setup

1. Create the standard ODW Dart directory structure

2. Download the release (stable) or development (dev) versions of the Dart software.

   • SDK
   • Dartium
   • Documentation

3. Setup Dart environment variables. For example on Windows:

set PATH=%PATH%;C:/tools/dart/stable/sdk/dart-sdk-1.17.0/bin
set PUB_CACHE: C:/tools/dart/pub/cache

WebStorm Installation and Setup

1. TODO: Add WebStorm defaults. a. install software b. install setup files b. set environment variables

2. TODO: Add Environment variables setup

Clone ODW SDK Repository

TODO:

Clone ODW Examples

Clone the ODW Examples Repository.

TODO:

Features and bugs

Please file feature requests and bugs at the issue tracker.