https://github.com/treecg/jquery-widget.js
A jQuery widget to query heterogeneous interfaces using Comunica SPARQL with support for TREE specification
https://github.com/treecg/jquery-widget.js
Last synced: about 1 month ago
JSON representation
A jQuery widget to query heterogeneous interfaces using Comunica SPARQL with support for TREE specification
- Host: GitHub
- URL: https://github.com/treecg/jquery-widget.js
- Owner: TREEcg
- License: mit
- Created: 2020-08-28T13:24:07.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-09-08T07:50:45.000Z (over 4 years ago)
- Last Synced: 2025-02-03T08:36:46.935Z (3 months ago)
- Language: JavaScript
- Homepage: https://treecg.github.io/jQuery-Widget.js/
- Size: 8.42 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Comunica SPARQL jQuery Widget
[
](http://linkeddatafragments.org/)
[](https://travis-ci.org/comunica/jQuery-Widget.js)
[](https://hub.docker.com/r/comunica/jquery-widget.js/)
**[Try the _Comunica SPARQL jQuery Widget_ online.](http://query.linkeddatafragments.org/)**
This jQuery widget is a browser-based user interface to the [Comunica SPARQL client](https://github.com/comunica/comunica/tree/master/packages/actor-init-sparql).
It allows users to execute SPARQL queries over one or multiple heterogeneous interfaces, such as [Triple Pattern Fragments interfaces](http://www.hydra-cg.com/spec/latest/triple-pattern-fragments/).
## Using the code
- Run `yarn install` to fetch dependencies and build the browser version of the client code.
- Run `yarn run dev` to run a local Web server (`yarn run dev-prod` for minified production output).
- 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 `yarn run build` to generate a production version in the `build` folder.
## How the browser client works
The original _Comunica SPARQL_ engine is written for the Node.js environment. The [Webpack](https://webpack.js.org/) library makes it compatible with browsers.
The query engine itself runs in a background thread using [Web Workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/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.
### Running in a Docker container
Configure your widget by editing the [settings.json](https://github.com/comunica/jQuery-Widget.js/blob/master/settings.json) file.
Next, edit the [queries directory](https://github.com/comunica/jQuery-Widget.js/tree/master/queries) in which you should insert the queries that will be present by default in the widget.
Build the [Docker](https://www.docker.com/) container as follows:
```bash
docker build -t comunica-sparql-widget .
```
After that, you can run your newly created container by mounting your current folder to the Docker container:
```bash
docker run -p 3000:80 -it --rm comunica-sparql-widget
```
Settings and queries can be passed at runtime by mounting your custom `queries.json` to the Docker container:
```bash
# Compile queries.json from settings.json and the files in the queries folder
./queries-to-json
# Provide the compiled queries.json at runtime
docker run -v $(pwd)/queries.json:/usr/share/nginx/html/queries.json -p 3000:80 -it --rm comunica-sparql-widget
```
> Access on http://localhost:3000
## License
The Linked Data Fragments jQuery Widget was originally written by [Ruben Verborgh](https://ruben.verborgh.org/)
and ported for Comunica SPARQL by [Ruben Taelman](http://rubensworks.net/).
This code is copyrighted by [Ghent University – imec](http://idlab.ugent.be/)
and released under the [MIT license](http://opensource.org/licenses/MIT).