Skip to content

Latest commit

 

History

History
63 lines (45 loc) · 3.36 KB

README.md

File metadata and controls

63 lines (45 loc) · 3.36 KB

Comunica

Comunica for HDT

Build Status Coverage Status Gitter chat

Learn more about Comunica on our website.

This is a monorepo that contains packages for allowing Comunica to query over HDT files, which are highly compressed files for storing large RDF datasets. If you want to use a HDT-enabled Comunica engine, have a look at Comunica SPARQL HDT.

Concretely, this monorepo adds HDT support to Comunica using the following packages:

Click here to learn more about Comunica HDT, or to see live examples.

Development Setup

(JSDoc: https://comunica.github.io/comunica-feature-hdt/)

This repository should be used by Comunica module developers as it contains multiple Comunica modules that can be composed. This repository is managed as a monorepo using Lerna.

If you want to develop new features or use the (potentially unstable) in-development version, you can set up a development environment for Comunica.

Comunica requires Node.JS 8.0 or higher and the Yarn package manager. Comunica is tested on OSX, Linux and Windows.

This project can be setup by cloning and installing it as follows:

$ git clone https://github.com/comunica/comunica.git
$ cd comunica
$ yarn install

Note: npm install is not supported at the moment, as this project makes use of Yarn's workspaces functionality

This will install the dependencies of all modules, and bootstrap the Lerna monorepo. After that, all Comunica packages are available in the packages/ folder and can be used in a development environment, such as querying with Comunica SPARQL HDT (engines/query-sparql-hdt).

Furthermore, this will add pre-commit hooks to build, lint and test. These hooks can temporarily be disabled at your own risk by adding the -n flag to the commit command.

License

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