aksw/ontopad

Simple RDF Editor with SHACL support

OntoPad

OntoPad is a simple editor for RDF data, e.g. Resources, Classes, and Properties. On top of the simple RDF layer it provides ways to visually interact with SHACL shapes.

OntoPad is designed to run in you web browser (with JavaScript support) and to be connected to a SPARQL Endpoint. To be able to share the data you create it works best with the Quit Store (actually currently only supported SPARQL Endpoint cf. #18).

To build the code and get it running in your development environment you need a recent version of node (node.js) and npm (https://nodejs.org/). You can also get it running in a docker environment with our docker image aksw/ontopad.

Project setup

npm install

Compiles and hot-reloads for development

npm run serve

Now the OntoPad should be locally available at http://localhost:8080/ or some other port, if port 8080 is used already.

Compiles and minifies for production

npm run build

This will set APP_CONFIG to null. To set APP_CONFIG now the configuration can be injected. If APP_CONFIG remains null OntoPad will fail to load, this might change in the future (#19).

Inject configuration

You can adjust src/config/config.json or set the following environment variables

• QUIT_URL the URL of a running Quit Store
• SPARQL_QUERY the URL of a SPARQL Query Endpoint (currently only Quit Store cf. #18)
• SPARQL_UPDATE the URL of a SPARQL Update Endpoint (currently only Quit Store cf. #18)
• PRESELECTED_GRAPH_IRI the IRI of the RDF Graph to select per default
• PRESELECTED_RESOURCE_IRI the IRI of the RDF Resource to select per default

Now run the following to inject the configuration:

node docker-inject-config.js

Compile and build for serving locally

NODE_ENV=dev npm run build

(NODE_ENV just must not be production.) This includes the default configuration from src/config/config.json to set APP_CONFIG. This configuration expects the SPARQL-Endpoint to be a Quit Store running at http://localhost:5000.

The result can be served with a local HTTP server

cd dist
python3 -m http.server 8080

Run your tests

npm run test

Lints and fixes files

npm run lint

Customize configuration

See Configuration Reference.

ontopad's Issues

Support for blank nodes in the SHACL interface

Provide support for blank nodes in the SHACL interface. By setting the blank ids instead of the named nodes to the diagram and probably by performing an atomic graph diff.

Drag and drop does not work in Firefox

I don't know what has changed, but suddenly the drag & drop does not work in my Firefox anymore, but in Chromium.
Could someone please reproduce this.

Switch to new SHACL based RDForm

Switch to new SHACL based RDForm and remove HTML RDForm templates

Requirements on read-me file

The read-me file should contain a reserved place specifying the requirements to use the application.
Example:

Requirements:

• Docker
• WebBrowser compatible with HTML and javaScript.
• NPM
• QUIT store

etc...

`npm run dev` does not work

According to https://github.com/AKSW/OntoPad/blob/master/README.md, I can run OntoPad using npm run dev, however that results in npm ERR! missing script: dev.

Add Feedback after storing data

Inform the user that a save/store action was started and show a toast when the data was successfully stored or an error occurred: https://bootstrap-vue.org/docs/components/toast

Broken link to the demo

The link to the demo of OntoPad is broken (returns 404 Not Found error):

https://ontopad.aksw.org/

QUIT store in the read-me file

Should have a section reserved to explain how to set up the QUIT store(at least the docker version) and a link to the QUIT store GitHub for further configurations.

Suppoert and test other SPARQL 1.1 Endpoints

Currently the OntoPad can only execute SPARQL Query and Update operations on the Quit Store. It should be able to work on other stores like Virtuoso, maybe also Fuseki (we have to check the dataset/named graph concept).

Tutorial/video with at least one example

The creation of a manual/tutorial/video explaining at least one example working with the whole application.

Dynamically set configuration (SPARQL Endpoint, …)

The OntoPad currently fails, if no config is set. Which is fine. At some point in the future, it might be cool to allow users to dynamically set the configuration with a wizard and store in in local config or something like that.

Should say to open http://localhost:8081

In someplace on read-me file should state that after the command "npm run dev" you should open your web-browser on this address "http://localhost:8081".

How to create SHACL constraints and enforce them on new data?

Hi,

I'm interested in the project and was curious if it's possible to both define shacl constraints and enforce them on newly added data. Is this possible? I don't completely understand where the shapes end up and what they do after creating them in the vocabulary tab.

Am I missing something?

Kr,
Timon

Add the possibility to import data

Loading a full dataset (e.g. in Turtle format, with instances, etc.) should be possible

Fix reload of shapes

Remove shapes when reloading the shape view.

add some sample images

@rmeissn @white-gecko Could you add some sample images to READM and https://aksw.github.io/OntoPad/?

The demo https://demo.ontopad.aksw.org/#/voc is down, and I'd like a quick way to see how this editor looks.

npm install on MacBook Pro

npm install does not work and need sudo rights to work. Thus, instead of "npm install" should be "sudo npm install".

Add a possibility to provision the OntoPad with a store connection configuration

Add a possibility to provide a configuration for the SPARQL Endpoint/Triple Store to use with the OntoPad.
I think this might help: https://codeburst.io/passing-configuration-to-vue-js-1b96fa8f959

How to serve output of npm build?

As npm run dev did not work for me, I successfully built the project using npm run build, however I cannot figure out how to start it then.
I tried opening dist/index.html on Firefox Developer 87.0b8 and Chromium 89.0.4289.82 even with the CORS addon activated but there is just a white screen.

The console shows the error message:

Loading failed for the module with source “file:///js/chunk-vendors.63bccdb5.js”. index.html:1:1
Loading failed for the module with source “file:///js/app.22d9930c.js”. index.html:1:1

I also deployed it on a local webserver using $ python -m http.server . but that failed as well.