Skip to content
A purely functional JSON library for Kotlin built on Λrrow
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
benchmarks Upload benchmark [ci skip] May 7, 2019
deploy-scripts
docs Add Robeen graphs (#63) May 6, 2019
gradle Add deploy (#52) May 2, 2019
helios-benchmarks Skip bintrayUpload task from docs module (#68) May 7, 2019
helios-core Add deploy (#52) May 2, 2019
helios-dsl-syntax-compiler Add deploy (#52) May 2, 2019
helios-meta-compiler Add deploy (#52) May 2, 2019
helios-meta Add deploy (#52) May 2, 2019
helios-optics Add deploy (#52) May 2, 2019
helios-parser Add deploy (#52) May 2, 2019
helios-sample Add deploy (#52) May 2, 2019
helios-test Add deploy (#52) May 2, 2019
infographic formatting and clean up Nov 10, 2018
.gitignore Merge remote-tracking branch 'origin/master' into arf-improve-docs Apr 15, 2019
.travis.yml Upgrade hood 0.6.0 (#64) May 7, 2019
LICENSE Add Jawn attribution Jan 19, 2018
README.md Upgrade hood and include more benchmark docs (#62) Apr 29, 2019
build.gradle Upgrade hood 0.6.0 (#64) May 7, 2019
detekt.gradle
detekt.yml fix detekt Apr 8, 2019
gradle.properties
gradlew
gradlew.bat Initial prototype Jan 19, 2018
settings.gradle Skip bintrayUpload task from docs module (#68) May 7, 2019

README.md

Helios

Helios is a library used to transform Json text into a model and vice versa. It's based on part of the Jawn Parser built on Arrow, a Functional companion to Kotlin's Standard Library.

Learn more on 47deg.github.io/helios

Why Helios

Helios is one of the fastest Json parser libraries in Kotlin with the advantage of using the Arrow library for functional programming.

Adding the dependency

Helios uses Kotlin version 1.3.31 and Arrow version 0.9.0.

To import the library on Gradle, add the following repository and dependencies:

repositories {
      maven { url "https://jitpack.io" }
 }

dependencies {
    compile "com.47deg:helios-core:0.0.1-SNAPSHOT"
    compile "com.47deg:helios-meta:0.0.1-SNAPSHOT"
    compile "com.47deg:helios-parser:0.0.1-SNAPSHOT"
}

Running Benchmarks

To run the benchmarks for comparing Helios with other Json libraries, execute the following command:

./gradlew :helios-benchmarks: executeBenchmarks

To run the benchmarks with Helios' performance, execute the following command:

./gradlew :helios-benchmarks: executeHeliosBenchmark

Running Microsite

To run the Helios microsite locally, you need to execute the following command:

bundle install --gemfile ./docs/Gemfile --path vendor/bundle

Next, you'll be able to run the following command:

BUNDLE_GEMFILE=docs/Gemfile bundle exec jekyll serve -s docs
You can’t perform that action at this time.