A jQuery widget to query Triple Pattern Fragments interfaces
JavaScript CSS HTML
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
deps
images
queries
.dockerignore
.eslintrc
.gitignore
.gitlab-ci.yml
.travis.yml
Dockerfile
LICENSE.txt
README.md
favicon.ico
gulpfile.js
index.html
ldf-client-ui.js
ldf-client-url-state.js
ldf-client-worker.js
ldf-client.css
package.json
queries-to-json
settings.json

README.md

Linked Data Fragments jQuery Widget

Build Status Docker Automated Build

Try the Linked Data Fragments jQuery Widget online.

This jQuery widget is a browser-based user interface to the Linked Data Fragments client. It allows users to execute SPARQL queries over one or multiple datasets exposed through a Triple Pattern Fragments interface.

Using the code

  • Run npm install to fetch dependencies and build the browser version of the client code.
  • Run npm start to run a local Web server.
  • Edit datasources in settings.json and queries in the queries folder, and run queries-to-json to compile both of them in a single JSON file.
  • Run npm run production to generate a production version in the build folder.

How the browser client works

The original ldf-client library is written for the Node.js environment. The browserify library makes it compatible with browsers.

The query engine itself runs in a background thread using Web Workers. The user interface (ldf-client-ui.js) instructs the worker (ldf-client-worker.js) to evaluate queries by sending messages, and the worker sends results back.

(Optional) Running in a Docker container

If you want to rapidly deploy this widget as a microservice, you can build a Docker container as follows:

$ docker build -t ldf-client-widget .

Next, configure your widget by creating a settings.json file in your working directory based on the example. Next, create a queries directory in which you should insert the queries that will be present by default in the widget, as is done here.

After that, you can run your newly created container by mounting your current folder to the Docker container:

$ docker run -p 3000:3000 -it --rm -v $(pwd)/:/tmp/ ldf-client-widget

License

The Linked Data Fragments jQuery Widget is written by Ruben Verborgh.

This code is copyrighted by Ghent University – imec and released under the MIT license.