Risk Reduction Overview Editor

This document contains information necessary for developers to understand the key aspects of the RRO application.

JointJS

At the core of the RRO application is the JointJS diagramming library. It is used to render the shapes (Risks, Measures) and links between them.

RRO File Format

The .rro file format is JSON converted to text. The structure is as follows:

{
    "name": "Name of the diagram",
    "graph": { /* graph data */ }
}

Detailed information about the structure of the graph data can be found here.

Installing

Dependencies:

• node

To install project you need node with npm. When you have them installed just type in terminal (or use any tool that is suitable for it)

npm install

Development

For development purposes just run:

npm start

It will start watcher on all project files, rebuild instantly after any changes, refresh page. Serves on localhost:9001.
Remember that changes shouldn't be made in /dist catalogue as it's generated automatically from all files.

Building

There are two tasks for building project:

npm run dist-dev
npm run dist-prod

Dev version builds with map to app.js and styles.css. After building /dist catalogue will be created, and it will contain version ready to deploy.

JavaScript Code Styling

To run the code styling checks, use the following command from within the project directory:

npm run jscs