Yavin

Rapidly build production quality analytics applications

Yavin App

Yavin is a framework for rapidly building custom data applications that offers both a UI and an API. Yavin can also be deployed as a standalone business intelligence tool in a few simple steps. Build reports, assemble dashboards, and explore data with ad-hoc queries.

This is an example app built using the Yavin Framework showing a Netflix dataset that is sourced from Kaggle data.

Getting Started

Quick start (no build required)

Launch demo app using latest yavin-app jar curl https://raw.githubusercontent.com/yavin-dev/app/master/yavin-run.sh | bash

Pre-requisites for local build

Install Java 8 or greater (more info here)
git clone https://github.com/yavin-dev/app.git
cd yavin-app

Demo Data

The default build comes bundled with a demo data source running in H2 (in memory). To disable or remove the demo data source please do the following to the webservice build file (ws/src/build.gradle.kts):

Comment or remove following line and run the build commands.

implementation("dev.yavin","demo-config","0.10")

Start Yavin App

./gradlew bootRun
Open http://localhost:8080

Build & Test Deployable Jar

Build & Test:./gradlew build
Build Only:./gradlew build -x test
Build For Prod:./gradlew build -Penvironment=production
Run Jar: java -jar ws/build/libs/yavin-app*.jar

Run Tests

Test All: ./gradlew test
Test UI: ./gradlew ui:test
Test WS: ./gradlew ws:test

Clean Build

Clean All: ./gradlew clean
Clean UI: ./gradlew ui:clean
Clean WS: ./gradlew ws:clean

Customize

Define your DB config (currently loads data via the create-demo-data.sql script)
Define your table config
Check out our installation guide for more info

Resources

Yavin framework resources

More documentation can be found on yavin.dev

License

This project is licensed under the MIT License.

jkusa/app