Development

Development with / to vitrivr-engine has various facettes:

• Contributing to vitrivr-engine
• Developing an application using vitrivr-engine as a dependency
• Building a client to vitrivr-engine (possibly a UI)

Contributing to vitrivr-engine

Prerequisites

Setup

A new Module

Depending on vitrivr-engine

If you want to build your own application which either entirely relies, or partially builds on vitrivr-engine, you can add the vitrivr-engine dependencies:

Releases: Gradle Groovy:

mavenCentral()

Snapshots: Gradle Groovy:

maven {
        url "https://oss.sonatype.org/content/repositories/snapshots/"
    }

Dependencies: Add one or multiple of the following to your dependencies:

implementation group: 'org.vitrivr', name: 'vitrivr-engine-core', version: '0.0.1-SNAPSHOT'
implementation group: 'org.vitrivr', name: 'vitrivr-engine-index', version: '0.0.1-SNAPSHOT'
implementation group: 'org.vitrivr', name: 'vitrivr-engine-module-features', version: '0.0.1-SNAPSHOT'
implementation group: 'org.vitrivr', name: 'vitrivr-engine-query', version: '0.0.1-SNAPSHOT'
implementation group: 'org.vitrivr', name: 'vitrivr-engine-module-cottontaildb', version: '0.0.1-SNAPSHOT'
implementation group: 'org.vitrivr', name: 'vitrivr-engine-module-m3d', version: '0.0.1-SNAPSHOT'

Please refer to the releases to find a list of releases (excludig snapshots).

Clients to vitrivr-engine

The intended way to facilitate a client using vitrivr-engine is via the OpenApi Specification. However, this requires a running instance of vitrivr-engine as a prerequisite. Using the openapi-generator, one can generate client-facing code for the desired setup.