Files
Dylan Vorster 4786208fe6 more port docs
2019-08-11 13:25:35 +02:00

974 B

Getting Started

Get the package

The first thing you need to do, is grab the distribution files on NPM. You can do this either using yarn or npm.

Via yarn:

yarn add @projectstorm/react-diagrams@next

Via npm:

npm install @projectstorm/react-diagrams@next

When you run this in your project directory, this will install the library into ./node_modules/@projectstorm/react-diagrams. You will then find a dist folder that contains all the minified and production ready code.

Install the peer dependencies

The library includes it's dependencies as peer-dependencies, so yarn will output warnings letting you know which ones are missing. Simple install them, specifically these ones:

yarn add closest lodash react mathjs dagre pathfinding paths-js

We do this, so that you can better control the versions of these libraries yourself since you might make use of Lodash in other parts of your software.