/isoflow

Primary LanguageTypeScriptMIT LicenseMIT

readme-header

An open-source React library for drawing network diagrams.

License: MIT CircleCI

Key Features

  • Highly visual drag and drop interface: Express your architecture with icons, regions and connectors.
  • Customizable: Easily extend Isoflow with your own icons.
  • Export options: Export diagrams as code or images.

Roadmap

  • Keyboard & mouse shortcuts (undo / redo, copy / paste, zoom in / out)

🚢 Shipped

  • Export options
  • Docker image
  • Modifiable connector segments
  • Display labels over connectors
  • Layer re-ordering (bring forward / send to back)
  • Allow custom colours
  • Export diagrams as images
  • Allow main menu to be customised
  • Fit diagram to viewport
  • Pan & zoom controls
  • Nodes, connectors & groups
  • Local storage support
  • Icon support for AWS, GCP, Azure, K8S & generic network hardware (e.g. server, database)
  • Event callbacks
  • Documentation site

Quick start

Install the Isoflow editor npm package and isopacks (icon packages):

  • npm install isoflow
  • npm install @isoflow/isopacks

For more information, see our documentation.

CodeSandbox demo

Demo the latest version of Isoflow on CodeSandbox. The sandbox will always be synced with the main branch on the Github repo, and also includes the latest version of the developer documentation.

Professional support

Isoflow is free to use for personal and commercial projects. If you're using Isoflow commercially and require support, please get in touch. We are also looking for project sponsors.

Contributing