Environment Setup

Jump to bottom

Silvan Heller edited this page May 12, 2022 · 7 revisions

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

Prerequisites

It is expected that you have a JDK installed. We recommend one provided by Open JDK. Please develop on JDK 17+.

Furthermore, you also have to setup the storage layer, CottontailDB. Consult its documentation for setup and installation.

Setup

You should now have a running instance of CottontailDB. To install cineast, proceed:

Clone Cineast

git clone https://github.com/vitrivr/cineast.git

(Optional) Open Cineast with your IDE supporting Gradle (we recommend IntelliJ)
Download external files, such as codebooks by executing

./gradlew getExternalFiles

You're now ready! Proceed with the Getting Started page.