Skip to content

Local Installation

Kārlis Čerāns edited this page Sep 24, 2024 · 3 revisions

Local Installation of ViziQuer

There are two main use cases for a local installation of ViziQuer:

  • To query your own set of SPARQL endpoints that do not have their schemas preloaded on viziquer.app
  • To participate in the development of ViziQuer

Architecture

The ViziQuer tool suite consists of:

  • ViziQuer visual query tool itself
  • Data Shape Server (DSS) for serving the data schemata to ViziQuer
    • DSS stores its data in a PostgreSQL database which also needs to be present
  • The utility for data schema extraction from a SPARQL endpoint (OBIS Schema extractor) and the utility for storing the data in the DSS schema database (provided within the DSS repository), see Schema Extraction for details.

Data Shape Server (DSS)

The Data Shape Server serves a stored knowledge graph schema information (classes, properties and their connections) to ViziQuer.

In order to run ViziQuer, DSS needs to be installed and running.

Please follow installation instructions in the Data Shape Server repository.

Installing ViziQuer

Prerequisites:

Instructions for installing ViziQuer:

  1. Clone ViziQuer github repository
  2. Change to the ./viziquer/app directory of the cloned repository
  3. Create .env file based on the sample.env file provided. It should contain the URL of the DSS server, e.g. SCHEMA_SERVER_URL=http://localhost:3344/api
  4. Execute the command meteor npm ci to install the required packages
  5. To run the ViziQuer tool, type meteor in the ViziQuer directory. To run on a specific port: meteor --port 4000.

Using ViziQuer

Open the ViziQuer tool in a web browser, e.g., localhost:3000.

Now you can create a new user and start using ViziQuer (see Getting Started).

  • Start a new ViziQuer project by pressing the "New project" button

The first user to sign up to the new instance will get administrator rights (the rights to manage tool configurations).

Additional Information

Information about the architecture of the ViziQuer tool can be found at: