Quick Start Guide

Prerequisites #

Before getting started with Yavin, make sure to have:

mac logo For macOS #

  1. Java 8 or greater - You can check by running java -version.

    Free prebuilt OpenJDK binaries are available on https://adoptopenjdk.net.

  2. Git - You can check by running git --version

windows logo For Windows #

  1. Windows Subsystem for Linux - You can follow this guide to enable it
  2. An Ubuntu distribution
  3. Java 8 or greater - You can install it by running
    sudo apt-get update
    sudo apt-get install default-jdk

    Make sure it is working by running java -version

  4. Git - You can check by running git --version but it should come installed

Boot Example Yavin App Locally #

Once you are all set up, run the following steps (On Terminal for macOS, and on Bash for Windows) to boot the example Yavin app:

1.1 (Option 1) Run Jar Locally #

To kick of your custom data application building, you will only need the app repo.

git clone https://github.com/yavin-dev/app.git
./gradlew bootRun                           

1.2 (Option 2) Launch Demo App in Docker Container #

If local port is different then change the argument in below command. Format is -p <host port>:<container port>

docker run -p 8080:8080 docker.io/verizonmedia/yavin_demo:latest

(To stop the server at any time, type Ctrl-C in your terminal.)

2. Open The App In Your Browser #

Congratulations! You can now open http://localhost:8080. This will launch the Yavin application into your browser with the built in data set for Netflix and TV shows that is sourced from Kaggle data.

Steps In Action #

The video above is a recording of the steps required to boot the Yavin example app.

For a more extended list of commands that can be done once you clone the repo, please check: https://github.com/yavin-dev/app#getting-started

Info Link
Git Setup https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup
AdoptOpenJDK https://adoptopenjdk.net/index.html
Yavin App Repo https://github.com/yavin-dev/app.git
Demo Data https://www.kaggle.com/shivamb/netflix-shows