Quick Start Guide

Prerequisites

Before getting started with Yavin, make sure :

For MAC

1. Check if your system has Java 8 or greater, you can check so with . You can find free prebuilt OpenJDK binaries at https://adoptopenjdk.net.

Or on the terminal, install it using:

    sudo apt-get update
    sudo apt-get install default-jdk

Check again: java -version

1. See if Git is installed by executing: git --version If not then install it using:

    sudo apt-get update
    sudo apt-get install git

Check again: git --version

For Window

1. Install Bash on Windows 10: https://www.howtogeek.com/249966/how-to-install-and-use-the-linux-bash-shell-on-windows-10/
2. Next, launch the Ubuntu distribution:
3. Via the Bash environment, see if java is installed by executing: java -version. If not then install it using: (Do not try to use java installation for windows)

    sudo apt-get update
    sudo apt-get install default-jdk
   

   Check again: java -version

4. Via the Bash environment, see if Git is installed by executing: git --version If not then install it using:

    sudo apt-get update
    sudo apt-get install git

Check again: git --version

Boot Example Yavin App Locally

Once your machine has all met the prerequisites, run the following steps (On Terminal for MAC, and on Bash for Windows)to boot the example Yavin app:

1. Clone the project

git clone https://github.com/yahoo/yavin.git

2.1 (Option 1): Run Jar Locally

cd yavin/packages/webservice                 
./gradlew bootRun                           

2.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.)

3. 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.

Helpful Links