Skip to content

Local Installation

Kārlis Čerāns edited this page Jan 13, 2025 · 7 revisions

Local Setup of ViziQuer

There are two ways of setting up and running ViziQuer locally:

  • using ViziQuer Tools docker-based environment, and
  • installing the ViziQuer tool suite components individually (advanced).

Each of these options would allow:

  • To build schemas and queries over SPARQL endpoints that do not have their schemas preloaded on ViziQuer Playground,
  • Obtain and environment, where you are in charge of the created schemas, projects (involving schema diagrams and queries) and users.

The second option may be more convenient:

  • To participate in the development of ViziQuer

Both options follow the same architecture and both of them require obtaining the data schemas that are used to support the schema diagrams and visual query auto-completion in the ViziQuer tool (cf. Schema Extraction).

There are known clones of the ViziQuer Tools repository involving pre-built data schemas that are made ready for usage by the user projects:

Architecture

The ViziQuer tool suite consists of:

ViziQuer Tools (and its clones) provide wrappers involving ViziQuer, DSS and its PostGres database, as well as shorthands for initialization with built-in data schemas and (optionally) the sample projects.

Installation

Please follow the guidelines of installing and running ViziQuer Tools from its GitHub repository, or

Please follow instructions for manual ViziQuer and Data Shape Server (DSS) installation and configuration at their repositories.

Please note that in either option the schema database needs to be filled with the schemas of interest, as described in Schema Extraction. The clones of ViziQuer Tools may have some data schemas pre-installed. The data schemas can be transferred among ViziQuer installations on the database management level.

Running the tools

Upon the successful installation (in either option) and startup (either as a docker container, or as a meteor application), the tool environment is available via web browser at the specified port (e.g. localhost:3000), where the users can sign up.

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

After the sign up and sign in, the user can create projects (Creating a New Project) and work with schema diagrams and queries therein (cf. Wiki Home for available options described).

Clone this wiki locally