Ecosyste.ms: Awesome

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

https://github.com/ververica/acwern

Flink visualization library for blogposts
https://github.com/ververica/acwern

Last synced: about 2 months ago
JSON representation

Flink visualization library for blogposts

![Acwern Logo](gfx/logo.png)

# Acwern

[Phaser 3](https://phaser.io) based [Apache Flink](https://flink.apache.org) concept visualization library.

## Requirements

[Node.js](https://nodejs.org) is required to install dependencies and run scripts via `npm`.

## Getting started

Install all dependencies
```bash
npm install
```

Run a development server
```
npm run start
```

Build a dist
```
npm run build
```

Publish on Github page (you need to have access to the ververica/acwern repo)

```
npm run publish
```

## Documentation

### Use case description

A Flink use case is defined through a json file. This can look something like this:

```json
{

"config": {
"useBuffer": true|false
},

"job": {

"sources": [
{
"id": "source-1",
"type": "simple",
"config": {

}
}, ...
],

"sinks": [
{
"id": "sink-1",
"type": "simple",
"config": {

}
}, ...
],

"operators": [
{
"id": "operator-1",
"type": "simple",
"config": {

}
}, ...
],

"vertices": [
{
"from": "source-1",
"to": "operator-1",
"type": "simple",
"config": {

}
}
]

}
}
```

### `config`

The config object contains general options for the modelled use case as well es visual options.

**operator.useBuffer: `boolean`**
If set to true Operators will visualise buffers.

**operator.bufferSize: `integer`**
Value is only considered when *useBuffer* is set to `true`.

### `operators`

A list of operators.

### `sources`

A list of sources. Like in Flink sources are a special case of operators.

### `sinks`

A list of sinks. Like in Flink sinks are a special case of operators.

### `vertices`

A list of vertices that connect operators with each other.