Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/elbosso/elkjsmicroservice

This project is aimed at providing a microservice for laying out arbitrarily complex graphs. It builds on the project elk.js for the actual layout algorithms implementation.
https://github.com/elbosso/elkjsmicroservice

docker expressjs graphs javascript layout nodejs npm

Last synced: 5 days ago
JSON representation

This project is aimed at providing a microservice for laying out arbitrarily complex graphs. It builds on the project elk.js for the actual layout algorithms implementation.

Awesome Lists containing this project

README

        

# elkjsmicroservice

[![GitHub release](https://img.shields.io/github/release/elbosso/elkjsmicroservice/all.svg?maxAge=1)](https://GitHub.com/elbosso/elkjsmicroservice/releases/)
[![GitHub tag](https://img.shields.io/github/tag/elbosso/elkjsmicroservice.svg)](https://GitHub.com/elbosso/elkjsmicroservice/tags/)
[![GitHub license](https://img.shields.io/github/license/elbosso/elkjsmicroservice.svg)](https://github.com/elbosso/elkjsmicroservice/blob/master/LICENSE)
[![GitHub issues](https://img.shields.io/github/issues/elbosso/elkjsmicroservice.svg)](https://GitHub.com/elbosso/elkjsmicroservice/issues/)
[![GitHub issues-closed](https://img.shields.io/github/issues-closed/elbosso/elkjsmicroservice.svg)](https://GitHub.com/elbosso/elkjsmicroservice/issues?q=is%3Aissue+is%3Aclosed)
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/elbosso/elkjsmicroservice/issues)
[![GitHub contributors](https://img.shields.io/github/contributors/elbosso/elkjsmicroservice.svg)](https://GitHub.com/elbosso/elkjsmicroservice/graphs/contributors/)
[![Github All Releases](https://img.shields.io/github/downloads/elbosso/elkjsmicroservice/total.svg)](https://github.com/elbosso/elkjsmicroservice)
[![Website elbosso.github.io](https://img.shields.io/website-up-down-green-red/https/elbosso.github.io.svg)](https://elbosso.github.io/)

## Overview

This project is aimed at providing a microservice for laying out arbitrarily complex graphs. It builds on the project
[elk.js](https://github.com/OpenKieler/elkjs) for the actual layout algorithms implementation.

This project adds the plumbing for turning it into a service - actually it turns it into a docker container deployable
anywhere docker containers are welcome.

The provided `Dockerfile` builds an image for the service. If your fancy takes you to using it with docker-compose -
there is already a ready made example `docker-compose.yml` here that has some commented lines prepared for
integrating eith any [traefik-instance](https://containo.us/traefik/) you might already have set up.

After starting the container and provided you know *hostname* and *port* of said container, one can check out the functionality
of it by sending the provided `example.json` - for example using _curl_ by issuing the following command:

```shell
curl -H "Content-Type: application/json" --data-binary '@example.json' http://:
```

Many thanks also go out to
[nodejs](https://nodejs.org/de/docs/guides/nodejs-docker-webapp/)
and
[expressjs](http://expressjs.com/).