kieler / elk-live

A web page with a text editor for ELK Graph and a synchronized graphical view

ElkGraph Web

A web page with a text editor for ELK Graph and a synchronized graphical view.

Check it out here.

Uses:

• ELK
• elkjs
• sprotty

How To Run

The easiest way to start working with this project is to open it in gitpod.io with the button above. If you would like to compile and run it on your own machine, follow the instructions below.

Prerequisites: yarn, Java

git clone https://github.com/kieler/elk-live.git
cd elk-live/client
yarn install
yarn run build

cd ../server
./gradlew jettyRun

Then point your web browser to http://localhost:8080/

This project provides a container based runtime environment for the elk-live project.

Usage

Build and/or run image with Docker. You can start container on pre-built image with docker run ghcr.io/kieler/elk-live:master.

Local image build

You can also build an container image locally by using the provided Dockerfile or, more comfortable, using docker-compose.yml with docker-compose up --build and docker build, respectively. This way you can locally adapt the runtime environment to your needs and even develop actively with nicely separated build- and runtime dependencies.

To easily get started with a locally built image, follow the steps below

cp .env.example .env
vi .env # adapt settings via provided environment
docker-compose up --build

Hosting

If you would like to host elk-live yourself you can use the automatically built Docker container. There is also an example configuration for Docker Compose.