Skip to content

Development Environment Setup

Loris Sauter edited this page Aug 12, 2019 · 1 revision

Development Environment Setup

This is a guide on how to set-up your local development environment to contribute to cineast.


Note

This guide w.r.t. the multi-module branch.


Prerequisites

It is expected that you have a JDK installed. We recommend one provided by Open JDK. Minimal version is JDK for Java SE 8.

Furthermore, you also have to clone the storage layer, CottontailDB. As of CottontailDB's current version, the steps to prepare your local CottontailDB instance are as follows:

  1. Clone CottontailDB:
git clone --recursive https://github.com/ppanopticon/cottontaildb.git
  1. Setup and build CottontailDB:
$> ./gradlew clean generateProto generateGrammarSource build
  1. Run CottontailDB
$> java -jar build/libs/cottontaildb.jar
  1. Whenever required, update the submodules:
$> git submodule update --init --recursive

Setup

As of now, you have set-up CottontailDB which is running on its default port. These are your next steps:

  1. Clone Cineast
$> git clone --recursive https://github.com/vitrivr/cineast.git
  1. Build Cineast
$> ./gradlew clean generateProto build

By now, you should have all the required dependencies and preparation steps performed. To actually test / debug cineast now, you would use

org.vitrivr.cineast.api.Main as main class.

It has one mandatory argument; the config (cineast.json).

More coming soon(tm)

Clone this wiki locally
You can’t perform that action at this time.