Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/asyncapi/edavisualiser

View your system, events, applications through different perspectives
https://github.com/asyncapi/edavisualiser

angular asyncapi edavisualiser get-global-node-release-workflows get-global-releaserc nextjs nodejs react visualiser visualizer vue webcomponent

Last synced: 30 days ago
JSON representation

View your system, events, applications through different perspectives

Host: GitHub
URL: https://github.com/asyncapi/edavisualiser
Owner: asyncapi
License: apache-2.0
Created: 2022-10-27T15:26:15.000Z (about 2 years ago)
Default Branch: master
Last Pushed: 2024-04-09T16:37:00.000Z (7 months ago)
Last Synced: 2024-04-14T02:32:28.608Z (7 months ago)
Topics: angular, asyncapi, edavisualiser, get-global-node-release-workflows, get-global-releaserc, nextjs, nodejs, react, visualiser, visualizer, vue, webcomponent
Language: TypeScript
Homepage: https://asyncapi.github.io/EDAVisualiser
Size: 7.74 MB
Stars: 11
Watchers: 4
Forks: 6
Open Issues: 5
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        [![AsyncAPI EDAVisualiser](./docs/img/banner.png)](asyncapi.github.io/EDAVisualiser)

[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

[![Npm latest version](https://img.shields.io/npm/v/@asyncapi/edavisualiser)](https://www.npmjs.com/package/@asyncapi/EDAVisualiser)

[![License](https://img.shields.io/github/license/asyncapi/EDAVisualiser)](https://github.com/asyncapi/EDAVisualiser/blob/master/LICENSE)

[![last commit](https://img.shields.io/github/last-commit/asyncapi/EDAVisualiser)](https://github.com/asyncapi/EDAVisualiser/commits/master)

[![Playground](https://img.shields.io/website?label=playground&url=https%3A%2F%2Fasyncapi.github.io%2FEDAVisualiser)](https://asyncapi.github.io/EDAVisualiser) 

[![All Contributors](https://img.shields.io/badge/all_contributors-7-orange.svg?style=flat-square)](#contributors-)

---

https://user-images.githubusercontent.com/13396189/169362612-0b6129b6-09b6-4807-aff9-8b545bcbc5dc.mp4

---

- [EDAVisualiser](#edavisualiser)

  * [Installation](#installation)

  * [Inputs](#inputs)

  * [Views](#views)

    + [ApplicationFocusView](#applicationfocusview)

      - [**Configurations**](#configurations)

    + [ApplicationView](#applicationview)

      - [**Configurations**](#configurations-1)

    + [SystemView](#systemview)

      - [**Configurations**](#configurations-2)

  * [Showcases](#showcases)

  * [Contributors ✨](#contributors-%E2%9C%A8)

# EDAVisualiser

EDAVisualiser is a visualization library to show various views revolving around your application. An Application is seen as something that communicates with others through incoming and outgoing "connections". This is what makes up the foundation for the views.  

It is written in React, however, it also supports the most used frameworks such as [Vue](./examples/vue/) and [Angular](./examples/angular/), check out the [examples](./examples/) for concrete code examples.

## Installation

Run this command to install the visualizer in your project:

```bash

npm install @asyncapi/edavisualiser

```

## Inputs

The library uses a domain-driven approach, meaning we don't assume one or the other input but build on top of a domain model that is specific to this problem we are trying to solve.

| Input | Example | Description|

|:---:|:---:|:---:|

| [**AsyncAPI**](https://www.asyncapi.com/) | Preview, code | *Allows you to reuse pre-parsed AsyncAPI documents from the [official AsyncAPI parser](github.com/asyncapi/parser-js), underneath it splits up the AsyncAPI document into the core building blocks. AsyncAPI v2.0 -> v2.5 is supported.* |

| **Core building blocks** | Preview, code | *The core building blocks is the domain abstraction for inputs this is what any other input type is converted to.* |

## Views

A view could for example be how a ["system" of applications is related](https://asyncapi.github.io/EDAVisualiser/social-media), [how a single application relates to others](https://asyncapi.github.io/EDAVisualiser/social-media/application/notification_service), only the fantasy sets the limitations, and [feel free to propose new ideas](https://github.com/asyncapi/EDAVisualiser/issues/new)!

### ApplicationFocusView

Puts a single application in focus as part of a larger system. Used to figure out who is "connected" to the application.



#### **Configurations**

These are all the arguments you can use to configure the view.

| Arguments | Description | Value type | Default | 

|:---:|:---:|:---:|:---:|

| `application` | The core building block for setting the application information. | `ApplicationNodeData \| undefined` | `undefined` |

| `incomingOperations` | The core building block for setting incoming operations for the application. | `Array \| undefined` | undefined |

| `outgoingOperations` | The core building block for setting incoming operations for the application. | `Array \| undefined` | undefined |

| `external` | This is the main difference from the `ApplicationView` as it shows how external applications interact with it. | `Array \| undefined` | undefined |

| `asyncapi` | If the application is to be loaded from a pre-parsed AsyncAPI document, which can extend the node with a custom react component in the top of the node. I.e., if you want to render a button or whatever it can be. | `AsyncapiApplicationData \| undefined` | undefined |

| `layout` | Used to customize the layout of nodes by setting their position. | `(elements: FlowElement[]) => React.JSXElementConstructor \| undefined` | A column layout (`ColumnLayout`) |

| `sideMenu` | Used to create a custom menu, or whatever you wish to display within the view on top of the nodes. | `() => React.JSXElementConstructor \| undefined` | Simple headline with the library name |

| `includeControls` | Include controls to zoom in and out, focus and lock nodes. | `boolean \| undefined` | `false` |

| `edgeType` | Determine the type of edge between nodes. | Either `'smoothstep'`, `'step'`, `'straight'`, `'floating'`, `'default'`, `'simplebezier'`, `'animated'` | `smoothstep` 

### ApplicationView

Puts a single application in focus with only it's near connections that are incoming to the application or outgoing from it.



#### **Configurations**

These are all the arguments you can use to configure the view.

| Arguments | Description | Value type | Default | 

|:---:|:---:|:---:|:---:|

| `application` | The core building block for setting the application information. | `ApplicationNodeData \| undefined` | `undefined` |

| `incomingOperations` | The core building block for setting incoming operations for the application. | `Array \| undefined` | undefined |

| `outgoingOperations` | The core building block for setting incoming operations for the application. | `Array \| undefined` | undefined |

| `asyncapi` | If the application is to be loaded from a pre-parsed AsyncAPI document, which can extend the node with a custom react component in the top of the node. I.e., if you want to render a button or whatever it can be. | `AsyncapiApplicationData \| undefined` | undefined |

| `layout` | Used to customize the layout of nodes by setting their position. | `(elements: FlowElement[]) => React.JSXElementConstructor \| undefined` | A column layout (`ColumnLayout`) |

| `sideMenu` | Used to create a custom menu, or whatever you wish to display within the view on top of the nodes. | `() => React.JSXElementConstructor \| undefined` | Simple headline with the library name |

| `includeControls` | Include controls to zoom in and out, focus and lock nodes. | `boolean \| undefined` | `false` |

| `edgeType` | Determine the type of edge between nodes. | Either `'smoothstep'`, `'step'`, `'straight'`, `'floating'`, `'default'`, `'simplebezier'`, `'animated'` | `smoothstep` 

### SystemView

Puts the system/collection of applications in focus to figure out how they are all connected.



#### **Configurations**

These are all the arguments you can use to configure the view.

| Arguments | Description | Value type | Default | 

|:---:|:---:|:---:|:---:|

| `applications` | A list of all the applications within your "system". | `Array \| undefined` | `undefined` |

| `layout` | Used to customize the layout of nodes by setting their position. | `(elements: FlowElement[]) => React.JSXElementConstructor \| undefined` | A circle layout (`CircleLayout`) |

| `sideMenu` | Used to create a custom menu, or whatever you wish to display within the view on top of the nodes. | `() => React.JSXElementConstructor \| undefined` | Simple headline with the library name |

| `includeControls` | Include controls to zoom in and out, focus and lock nodes. | `boolean \| undefined` | `false` |

| `edgeType` | Determine the type of edge between nodes. | Either `'smoothstep'`, `'step'`, `'straight'`, `'floating'`, `'default'`, `'simplebezier'`, `'animated'` | `smoothstep` 

## Showcases

These are the use-cases and where this library is used that you can use as inspiration.

- AsyncAPI Studio, was where this library's components was [originally created and split out from](https://github.com/asyncapi/studio/pull/342). It uses this library to visualize AsyncAPI documents. 

Feel free to add your own projects that are using this library and why.

## Contributors ✨

Thanks go to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    

      
_{Jonas Lagoni}
💻 🤔 🚧 📖 💡

      
_{Maciej Urbańczyk}
💻 🤔 🚧

      
_{David Boyne}
💻 🤔

      
_{Shashwat Pratap Singh}
💻

      
_Zubeen
💻

      
_aybeedee
💻

      
_Anish
💻

    

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

Special thanks to [@magicmatatjahu](https://github.com/magicmatatjahu) for the react setup that allows the library to be offered to all frontend frameworks, and to [@boyney123](https://github.com/boyney123) for the initial visualization code that [first appeared in the AsyncAPI studio](https://github.com/asyncapi/studio/issues/261).