Matey

A browser-based editor meant for writing YARRRML rules. The corresponding RML rules can be exported for use outside of Matey. Additionally, the rules can be executed on a sample of the data, which allows users to inspect the generated Linked Data.

Table of contents

• Requirements
• Installation
• Usage
  • Setting up the RMLMapper Web API endpoint
  • Configuring Matey
• Developing
  • Installation
  • Debugging
  • Building
• Run tests
• License

Requirements

Node.js

Installation

npm install

Usage

Setting up the RMLMapper Web API endpoint

To generate Linked Data triples, Matey does its RML mapping through a remote server. For this, Matey requires you to provide an RMLMapper endpoint. You can either provide the URL of an existing server, or set one up yourself by following these instructions. Make sure that you provide the correct URL for the endpoint during configuration.

Configuring Matey

To configure Matey, create a configuration file config.json in the project root. The configuration options are:

• "rmlMapperUrl": URL of RMLMapper Web API endpoint

Example configuration file content file would be:

{
  "rmlMapperUrl": "http://localhost:4000/execute"
}

If you to run Matey with this configuration, make sure you have such an endpoint set up.

The file config.json is git-ignored and if you do not provide such a file, the scripts in package.json copy config-default.json to it.

Developing

Installation

Install dependencies via

npm install

Debugging

1. Build for debugging and spin up an HTTP server via

   npm run dev

2. Open http://localhost:5173 in the browser.

Building

Build a minimized version into ./dist:

npm run build

Run tests

The tests assume that an RMLMapper endpoint with URL https://rml.io/api/rmlmapper/execute is up and running.

Run the following commands from inside the project directory:

npm install
npm test

License

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