onboarding.md

SellBook :: Developer Guide

Development environment {#requirements .choice}

Prepare environment on Linux

Install Sdkman {.optional}

You can follow the next documentation: Sdkman installation

$ curl -s "https://get.sdkman.io" | bash
$ source "$HOME/.sdkman/bin/sdkman-init.sh"
$ sdk version

Install GraalVM {.optional}

• GraalVM
• NativeImage

$ sdk install java 22.0.0.2.r17-grl
$ sdk use java 22.0.0.2.r17-grl
$ gu install native-image

Prepare environment on Mac

TODO ???

Build

make is used as index to launch different targets.

Tools

• make
• gradle
• GraalVM Gradle Plugin
• Gradle Shadow Plugin

Build artifacts {#build-artifacts .menu}

Build JAR

$ make jar

Build Native

$ make native

Libraries used

• intellij-markdown : markdown processor
• Clikt : command line interface for kotlin
• Mordant : colorful styling for command-line applications
• kotlin-inquirer : a collection of common interactive command line user interfaces