Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/abbe98/thor

A platform-agnostic, configurable, and brandable SPARQL editor and visualization interface.
https://github.com/abbe98/thor

sparql

Last synced: 11 days ago
JSON representation

A platform-agnostic, configurable, and brandable SPARQL editor and visualization interface.

Host: GitHub
URL: https://github.com/abbe98/thor
Owner: Abbe98
License: gpl-3.0
Created: 2019-04-19T17:16:15.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-09-19T12:42:42.000Z (about 2 months ago)
Last Synced: 2024-10-10T18:54:05.571Z (28 days ago)
Topics: sparql
Language: JavaScript
Homepage:
Size: 1.5 MB
Stars: 11
Watchers: 4
Forks: 2
Open Issues: 5
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Thor SPARQL Editor

_A platform-agnostic, configurable, and brandable SPARQL editor and visualization interface._

## Features

- Autocompletion of your entire ontology
- Result visualizations modes including; a table, an image grid, a pie chart, and a map
- Integration with your query library
- Shareable queries / URLs
- A resizable code editor
- An interactive tour of the GUI
- A configurable color scheme
- _...and plenty of more..._

## Configuration reference

### Struture

```json
{
"sparql_endpoint": "",
"query_library_endpoint": "",
"title": "",
"demo_tour": {
"demo_query": "",
"demo_query_cursor_position": {
"line": 1,
"ch": 1
}
},
"map_background": {
"url_template": "",
"attribution": ""
},
"color_scheme": {
"main_brand": "",
"main_brand_darkened": "",
"secondary_brand": "",
"secondary_brand_darkened": "",
"main_text": "",
"main_text_lighted": "",
"secondary_text": "",
"background": "",
"background_shaded": "",
"border": ""
},
"favicons": {
"favicon_success": "",
"favicon_error": "",
"favicon_progess": ""
},
"autocomplete": {
"classes": [],
"prefixes": [],
"properties": [],
"services": [],
"uris": []
}
}
```

### `sparql_endpoint`

The SPARQL endpoint to use. If left out, the user will be able to input their own endpoint.

### `query_library_endpoint`

The endpoint to use for the query library. If left out, the query library will be disabled.

### `title`

The title of the editor.

### `demo_tour`

An object for the demo tour configuration. If left out, the demo tour will be disabled. Note that the `demo_query` and `demo_query_cursor_position` can be used to trigger/demo autocompletion features as if a real user would be typing.

- `demo_query`: The query to use for the demo tour. Use `\n` for newlines.
- `demo_query_cursor_position`: The cursor position to use for the demo tour.
- `line`: The line number for the cursor position.
- `ch`: The character number for the cursor position.

### `map_background`

Optional map background settings.

- `url_template`: URL template for map tiles. [See URL template at leafletjs.com](https://leafletjs.com/reference.html#tilelayer).
- `attribution`: String to use for map attribution, can take HTML.

### `autocomplete`

An object for the autocompletion configuration.

- `classes`: An array of plain-class-URIs to autocomplete, `http://schema.org/CreativeWork` not `schema:CreativeWork`.
- `prefixes`: An array of prefixes to autocomplete, following SPARQL format, `rdfs: `, etc.
- `properties`: An array of plain-property-URIs to autocomplete, `http://www.w3.org/2000/01/rdf-schema#label` not `rdfs:label`.
- `services`: An array of federated endpoints to autocomplete, `http://dbpedia.org/sparql`, etc.
- `uris`: An array of URIs to autocomplete.

### `color_scheme`

An object for the color scheme configuration. These are all exposed as `root` CSS variables so you can tweak the defaults in the browser's dev tools before adding them to the configuration.

- `main_brand`
- `main_brand_darkened`
- `secondary_brand`
- `secondary_brand_darkened`
- `main_text`
- `main_text_lighted`
- `secondary_text`
- `background`
- `background_shaded`
- `border`

### Examples

- [FornPunkt](https://github.com/fornpunkt/sparql/blob/main/thor-configuration/config.json)
- [TORA (National Archives of Sweden)](https://github.com/Riksarkivet/ra-sokprototyper/blob/main/thor/config.json)

## Query libraries

A query library is a JSON file containing an array of queries. Each query is an object with the following properties:

- `title`: The title of the query.
- `tags`: An array of tags for the query.
- `body`: The query body.

It's common to generate this JSON file from a code-snippet library or from induvidual SPARQL query files. [Here is an example, generating a library from `.rq` files using Python.](https://github.com/fornpunkt/sparql/tree/main#adding-queries-to-the-library)

### Example

```json
[
{
"title": "List users by the number of monuments registered with a given tag",
"tags": [
"monuments",
"users",
"tags"
],
"body": "PREFIX schema: \n\nSELECT ?creator (COUNT(?monument) AS ?monument_count) WHERE {\n BIND( AS ?tag)\n ?monument schema:keywords ?tag ;\n a schema:CreativeWork ;\n schema:creator ?creator .\n}\nGROUP BY ?creator\nORDER BY DESC(?monument_count)\n"
},
]
```

## Deployment

Thor only consists of static files but expects to find your `config.json` file in the `config` directory. Your query library can also be served from the `config` directory if you wish.

- [NGINX: Serving Static Content](https://docs.nginx.com/nginx/admin-guide/web-server/serving-static-content/)
- [Caddy: Static files quick-start](https://caddyserver.com/docs/quick-starts/static-files)