Skip to content

Latest commit

 

History

History
44 lines (31 loc) · 2.65 KB

README.md

File metadata and controls

44 lines (31 loc) · 2.65 KB
Raw

Linked Data Fragments jQuery Widget

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 file browser.js makes the Node.js library ldf-client available in global scope as ldf.
This script is compiled with its dependencies to deps/ldf-client-browser.js via npm run postinstall.

You can use the resulting deps/ldf-client-browser.js in your browser applications; it is independent of the jQuery UI widget.

(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 in which settings.json and queries is mounted to the Docker container:

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

License

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

This code is copyrighted by Multimedia Lab – iMinds – Ghent University and released under the MIT license.