https://github.com/dbsystel/grapheditor
Editor for labeled property graph databases with semantic support
https://github.com/dbsystel/grapheditor
graph graph-editor graph-editor-gui graph-visualization semantic ui
Last synced: 21 days ago
JSON representation
Editor for labeled property graph databases with semantic support
- Host: GitHub
- URL: https://github.com/dbsystel/grapheditor
- Owner: dbsystel
- License: agpl-3.0
- Created: 2025-08-07T14:39:56.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-12-10T19:25:26.000Z (2 months ago)
- Last Synced: 2025-12-11T06:38:03.312Z (2 months ago)
- Topics: graph, graph-editor, graph-editor-gui, graph-visualization, semantic, ui
- Language: TypeScript
- Homepage:
- Size: 2.45 MB
- Stars: 5
- Watchers: 1
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Maintainers: MAINTAINERS.md
Awesome Lists containing this project
README
* [Intro](#intro)
* [Status and features](#status-and-features)
* [Screenshot](#screenshot)
* [Architecture](#architecture)
* [Authors](#authors)
* [LICENSE](#license)
* [Contributions, updates and contact](#contributions-updates-and-contact)
* [Updates and contributions](#updates-and-contributions)
* [Running it](#running-it)
* [Docker](#docker)
* [Mac issues with allocated memory](#mac-issues-with-allocated-memory)
* [Changes in node_modules](#changes-in-node_modules)
* [Mounting host directories with correct rights](#mounting-host-directories-with-correct-rights)
* [Exe](#exe)
* [Directly](#directly)
# Intro
This repo contains the GraphEditor. It is an editor for labeled property graph databases (as
provided by neo4j or memgraph).
## Status and features
The software is in its early stages - it works (for us), but lots of features are not yet
implemented. Also expect lots of bugs :-)
Exiting main features are:
- Semantic support: all labels, relationtypes and properties can have meaningful metadata, which in
turn can be edited and extended by the same editor - it is all stored in the graph database
- Semantic support for editing
- Persistent node arrangements (perspectives) - you can drag a selection of nodes into position, and
store the arrangement in the database, reusable by other users
- WebGL Support (provided by sigma.js), which means we can display thousands of objects
- Rectangular nodes
- Support for styling files (.grass) that can contain python snippets for dynamic styling
- Support for fulltext search (optional)
- Parameterized queries - build your own query forms using the graph to query the graph
- Custom start page with query shortcuts
- Multi tenancy support
## Screenshot & video
There is also a video from the nodes2025 conference, showing release 2025.11.1:
- https://www.youtube.com/watch?v=nc1cAtnjvcQ
## Architecture
```plantuml
@startuml
skinparam defaultTextAlignment center
rectangle "Frontend\n\ntypescript / react" as frontend
rectangle "Backend\n\npython / flask" as backend
database "LPG\n\nGraph Database" as lpg
frontend <--> backend
backend <--> lpg
@enduml
```
The editor consists of two parts:
- The frontend, written in react/typescript, that the user interacts with.
- The backend, written in python, that provdes an API that is used by the frontend, and in turn
talks to the LPG database, mostly neo4j.
# Authors
The graph editor is produced and published by DB Systel GmbH, a 100% subsidary of Deutsche Bahn.
The whole of team InfraGraphAnalytics (IGA) has been working hard to make the grapheditor possible.
We also had outside inspiration, thanks a lot for this!
See [CONTRIBUTORS](CONTRIBUTORS.md)
Maintainers are listed in [MAINTAINERS](MAINTAINERS.md)
# LICENSE
GraphEditor, a gui with semantic support for labeled property graph databases
Copyright (C) 2025 DB Systel GmbH
This program is free software: you can redistribute it and/or modify it under the terms of the GNU
Affero General Public License as published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero
General Public License for more details.
See [LICENSE.txt](LICENSE.txt) for the full license.
# Contributions, updates and contact
See [CONTRIBUTING](CONTRIBUTING.md)
# Updates and contributions
This repo is a partial copy of our internal repo. We try to update this repo whenever we cut a new
release.
You are welcome to send us merge requests.
# Running it
## Docker
- Docker must be installed
- copy .env.dist into .env and change the variables according to your system.
To build the docker images, run `sh build.sh dev` (or `sh build.sh prod` for production).
To run a dev server for backend and frontend, run `docker-compose up` (see /frontend/README.md if
you are working with GUI).
If you need mock data to explore the project, please visit http://localhost:4999/api/swagger. Before
starting, make sure you are logged in using the GUI interface. Then, under the headline "Dev tools",
chose one of the entries "reset" (simple database with Alice, Bob and a meta model) and "osm_data".
Click on "Try it out", type an arbitrary "x-tab-id" and execute it to get mock data.
**Caution**: this will replace all your data in the neo4j database. Double-check you are connected
with the database you want to overwrite.
### Mac issues with allocated memory
Mac users might run into an issue with memory when starting the frontend image. To fix this,
increase the allowed allocated memory of your vm. Either in Docker-Desktop, or if using colima,
start your vm with `colima start --cpu 4 --memory 8`.
### Changes in node_modules
If you added node modules, or simply want to rebuild the image, run `docker-compose down` followed
by `docker-compose up --build`
### Mounting host directories with correct rights
Our docker-compose.yml mounts some local directories to allow persisting stuff like Neo4j data and
plugins. By default Neo4j either creates them or, if existing, changes the permissions of these
directories so that they are owned by root. If you wish to change this, you can define a local
override file, for example:
```bash
$ cat docker-compose.override.yml
services:
neo4j-enterprise:
user: "1000:1000"
```
## Exe
An executable can be build using pyinstaller.
Build the frontend using `npm run build`, and copy the contents of the dist folder to the gui folder
in the backend. Then, within the backend folder run:
`pyinstaller --onefile --add-data 'index.html:.' --add-data 'static:static' --add-data 'gui:gui'
--add-data '<... YOUR BASE PATH ...>\\venv312\\Lib\\site-packages\\flask_smorest\\spec:flask_smorest
' -i gui/IGA_Favicon.ico -n IGA_Editor_0_2_alpha_1 main.py
`
When executing the .exe, the urls to access are displayed in the console window.
## Directly
You can run the frontend and backend directly. Please check
- [Frontend README](frontend/README.md)
- [Backend README](backend/README.md)