No description
Find a file
2023-03-29 23:50:05 +01:00
.circleci chore: runs tests on CI 2023-03-29 23:50:05 +01:00
src fix: tests not passing 2023-03-29 23:47:30 +01:00
webpack chore: enables webpack dev server 2023-03-24 23:32:36 +00:00
.gitignore chore: configures CI 2023-03-16 21:27:09 +00:00
jest.config.js feat: replaces xstate with custom state machine implementation 2023-03-22 00:19:00 +00:00
LICENSE
package-lock.json 0.3.15 2023-03-28 23:14:20 +01:00
package.json 0.3.15 2023-03-28 23:14:20 +01:00
README.md chore: updates README with first contributions guide 2023-03-29 23:23:26 +01:00
tsconfig.json feat: exports types 2023-03-23 20:59:59 +00:00

readme-header

GitHub License MIT CircleCI

A highly customizable React component for building interactive network diagrams.

Coming soon under the MIT licence | Use it now on isoflow.io

Key Features

  • Real-time: Display real-time data on diagrams.
  • Customizable: Use your own isometric icon packs, or use our free set of networking icons (also under MIT).
  • Export options: Export diagrams as images, JSON or YAML.
  • Powerful annotation tools: Annotate nodes, groups and connectors.
  • Step-by-step walkthroughs: Create interactive tours of large diagrams to help viewers easily digest information.

Roadmap

Migration to open-source: ██░░░░░░░░░

  • Set up automated publishing to NPM registry
  • Migrate private JS project to public Typescript project
    • Pan / Select / Zoom modes
    • Display icons in sidebar
    • Nodes
    • Groups
    • Connectors
  • Publish icons as separate importable package

Want to contribute?

See good first issues.

Installation

Note: Isoflow is currently not production ready. To view it's current state of development:

npm install isoflow

import Isoflow from 'isoflow';

const App = () => (
  <Isoflow
    height={500}
    scene={{
      icons: [],
      nodes: [],
      connectors: [],
      groups: []
    }}
  >
)

If using Next.js, make sure you only import Isoflow in the browser:

const Isoflow = dynamic(() => import("isoflow"), {
  ssr: false,
});

License

Isoflow is MIT licensed (see ./LICENSE).