Live Demo: https://raw.githack.com/ontopic-vkg/webcomp-kg/master/example/index.html
Include the webcompscript files webcomp-kg.js and webcomp-kg.css in your HTML and define the web components like below.
A Web Component <kg-widget> with three visualizations (map, table, and image gallery) is defined.
<body>
<script src="webcomp-kg.js"></script>
<link rel="stylesheet" href="webcomp-kg.css">
<kg-widget view="map" endpoint='https://sparql.opendatahub.bz.it/sparql' query="PREFIX schema: <http://schema.org/>
PREFIX geo: <http://www.opengis.net/ont/geosparql#>
SELECT ?h ?pos ?posLabel ?posColor
WHERE {
?h a schema:LodgingBusiness ;
geo:asWKT ?pos ;
schema:name ?posLabel ;
schema:address ?a .
FILTER (lang(?posLabel) = 'de')
# Colors
OPTIONAL {
?h a schema:Campground .
BIND('chlorophyll,0.5' AS ?posColor) # Green
}
OPTIONAL {
?h a schema:BedAndBreakfast .
BIND('viridis,0.1' AS ?posColor) # Purple
}
OPTIONAL {
?h a schema:Hotel .
BIND('jet,0.3' AS ?posColor) # Light blue
}
OPTIONAL {
?h a schema:Hostel .
BIND('jet,0.8' AS ?posColor) # Red
}
}
LIMIT 500"
>
</kg-widget>
</body>View
Type: string
Possible values: 'map', 'table', 'gallery'
The SPARQL endpoint
Type: string
The SPARQL query
Type: int
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
To build the project, the following prerequisites must be met:
- Node 12
For a ready to use Docker environment with all prerequisites already installed and prepared, you can check out the Docker environment section.
Get a copy of the repository:
git clone https://github.com/noi-techpark/webcomp-kgChange directory:
cd webcomp-kg/Download all dependencies:
npm installBuild and start the project:
npm run buildThen you can see the examples at the examples directory.
The tests and the linting can be executed with the following commands:
npm run test
npm run lintTo create the distributable files, execute the following command:
npm run buildFor the project a Docker environment is already prepared and ready to use with all necessary prerequisites.
These Docker containers are the same as used by the continuous integration servers.
Install Docker (with Docker Compose) locally on your machine.
First, install all dependencies:
docker-compose run --rm app /bin/bash -c "npm install"Before start working you have to start the Docker containers:
docker-compose up --build --detach
After finished working you can stop the Docker containers:
docker-compose stop
When the containers are running, you can execute any command inside the environment. Just replace the dots ... in the following example with the command you wish to execute:
docker-compose run --rm app /bin/bash -c "..."Some examples are:
docker-compose run --rm app /bin/bash -c "npm run test"For support, please contact info@opendatahub.bz.it.
If you'd like to contribute, please follow the following instructions:
-
Fork the repository.
-
Checkout a topic branch from the
developmentbranch. -
Make sure the tests are passing.
-
Create a pull request against the
developmentbranch.
A more detailed description can be found here: https://github.com/noi-techpark/documentation/blob/master/contributors.md.
More documentation can be found at https://opendatahub.readthedocs.io/en/latest/index.html.
The project uses this boilerplate: https://github.com/noi-techpark/webcomp-boilerplate.
The code in this project is licensed under the AGPL 3 license. See the LICENSE.md file for more information.