Dylan Vorster 94fe0fc854 Updates docs/Getting Started.md
Auto commit by GitBook Editor
2018-03-17 12:16:26 +00:00
2018-02-24 18:44:07 +02:00
2018-01-07 23:01:50 +02:00
2018-03-13 21:36:48 +02:00
2018-03-17 12:16:26 +00:00
2017-04-25 21:02:38 +02:00
2018-03-08 18:16:58 +01:00
2018-03-10 15:32:24 +02:00
2017-11-21 00:39:19 +02:00
2018-03-03 21:57:17 +02:00
2018-02-25 11:59:14 +02:00
2016-06-13 11:48:10 +02:00
2018-03-13 21:36:48 +02:00
2018-03-03 21:57:47 +02:00
2018-03-17 12:16:26 +00:00
2018-03-13 21:36:48 +02:00
2018-03-13 21:36:48 +02:00
2018-03-13 21:36:48 +02:00

STORM React Diagrams

DEMO: http://www.projectstorm.io/react-diagrams

RELEASE NOTES : http://dylanv.blog/2018/03/03/storm-react-diagrams-5-0-0/

A super simple, no-nonsense diagramming library written in React that just works.

Join the chat at https://gitter.im/projectstorm/react-diagrams NPM NPM CircleCI

Personal Project

Introduction

A no-nonsense diagramming library written entirely in React with the help of a few small libraries. It aims to be:

  • Simple, and void of any fuss/complications when implementing it into your own application
  • Customizable without having to hack the core (adapters/factories etc..)
  • Simple to operate and understand without sugar and magic
  • Fast and optimized to handle large diagrams with hundreds of nodes/links
  • Super easy to use, and should work as you expect it to
  • Perfect for creating declarative systems such as programmatic pipelines and visual programming languages

Usage

Installing

npm install storm-react-diagrams or yarn add storm-react-diagrams

Getting started

The best place to start is by looking at the simple demos demos/demo-simple and going from there.

Run the demos

After running yarn install you must then run: yarn run storybook

Building from source

Simply run webpack in the root directory (or export NODE_ENV=production && webpack if you want a production build) and it will spit out the transpiled code and typescript definitions into the dist directory as a single file. We use webpack for this because TSC cannot compile a single UMD file (TSC can currently only output multiple UMD files).

Make your own nodes

To see how to create your own nodes like the one below, take a look at demos/demo-custom-link1:

Demo2

Learn More

Architecture Questions

Interactive Questions

Testing the Library

Description
a super simple, no-nonsense diagramming library written in react that just works
Readme MIT 15 MiB
Languages
TypeScript 97.6%
JavaScript 2%
CSS 0.3%
HTML 0.1%