comunica / examples Goto Github PK

📚 A collection of Comunica example packages

License: Other

JavaScript 35.70% TypeScript 64.30%

examples's Introduction

Comunica Examples

This is a repository of Comunica examples.

The packages in this monorepo are just created as an illustration on how packages can be created that make use of Comunica, they are not published to npm. All of these examples are available under the MIT license, so you are welcome to reuse any code from these examples any way you want.

These examples are not meant to form fully detailed tutorials on how to build applications with Comunica. Instead, they represent fully functional packages with detailed documentation so that they can be used and adjusted as needed. If you are looking for detailed documentation for using and modifying Comunica, please refer to our website.

All of these examples make use of TypeScript, a typed superset of JavaScript. TypeScript is not a requirement for using Comunica. All these examples will still work when removing all TypeScript configs and removing all typings from the .ts files.

Examples

Configure a custom Comunica SPARQL instance

Replacing the HTTP actor with a Solid HTTP actor

Create a new Comunica actor

Contributing new examples

If you want to add examples to this repo, or if you want to fix mistakes in existing examples, you can clone and set up this repo as follows.

These examples require Node.JS 10.0 or higher and the Yarn package manager.

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

$ git clone https://github.com/comunica/examples.git
$ cd examples
$ 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 example packages are available in the packages/ folder.

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.

examples's People

Contributors

Stargazers

Watchers

Forkers

cbuil axrdo silenroc1

examples's Issues

Querying an in-memory dataset

Add an example on how an N3Store can be constructed, and how it can be queried (SELECT, CONSTRUCT, ASK).

Adding an action observer to a bus

For example, the HTTP or query operation bus, for tracking all actions.

Logging all HTTP requests

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

Update Comunica monorepo packages (major) (@comunica/actor-init-sparql, @comunica/bus-rdf-resolve-quad-pattern, @comunica/core, @comunica/runner)
Update dependency @rdfjs/data-model to v2

Detected dependencies

npm

package.json

lerna ^8.0.0

node >=10.0

packages/actor-observe-rdf-dereference/package.json

@comunica/actor-init-sparql ^1.21.1

@comunica/core ^1.21.1

@comunica/bus-rdf-dereference ^1.21.1

@comunica/runner ^1.21.1

typescript ^5.0.0

packages/actor-rdf-resolve-quad-pattern-api-weather/package.json

@comunica/actor-init-sparql ^1.21.1

@comunica/core ^1.21.1

@comunica/bus-rdf-resolve-quad-pattern ^1.21.1

@comunica/runner ^1.21.1

@rdfjs/data-model ^1.1.2

@types/minimist ^1.2.0

@types/n3 ^1.1.5

asynciterator ^3.1.0

typescript ^5.0.0

packages/configure-sparql-http-solid/package.json

@comunica/actor-init-sparql ^1.21.1

@comunica/actor-http-solid-auth-fetch ^1.2.0

@comunica/runner ^1.14.0

typescript ^5.0.0

Check this box to trigger a request for Renovate to run again on this repository

Adding a custom source type actor

For example, an actor that queries a specific API.

On actor-rdf-resolve-quad-pattern bus.

Adding a query optimization actor

We should add an example that shows how to tranform algebra on the Optimize Query Operation bus: https://comunica.dev/docs/modify/advanced/buses/#optimize-query-operation

Adding a custom query optimization algorithm

Prior to query execution.

On the query optimize bus.

Moving an example in another location throws an error

Hello!

I don't know if I'm doing something wrong, but I'm cloning this repository on my machine, then I run yarn install. I go then to the actor-observe-rdf-dereference example and I run node bin/run and it works without any problem.
Now I want to edit the example and to deploy it as a separate NPM package. So, I take the directory actor-observe-rdf-dereference and I move it to another location on my machine, and I run yarn install to install all Comunica's dependencies. But running node bin/run throws the following error:

@rubensworks you told me that it may be caused by outdated packages on Gitter but if was the cause of the issue, I think it shouldn't work at all, should it?