Repository Overview

In this article we want to give a basic overview over the shake main repository, as it is quite large and overwhelming to start with.

Build System

Shake is written in Kotlin and uses the Gradle build tool.

Shake specific stuff (shake-compiler, shake-bytecode, shake-shakespeare) can be found at /shake

Utility packages can be found at /util

Shake distribution (java) /bin

Shake distribution (browser) /bin

/.changelog - A directory to store metadata of the changelog tool used for shake versioning
/.github - A directory github specific data such as workflows are stored in
[/assets]((https://github.com/shakelang/shake/tree/master/assets) - A directory containing various assets needed for stylizing dokka
[/bin]((https://github.com/shakelang/shake/tree/master/bin) - Shake java distribution
[/browser]((https://github.com/shakelang/shake/tree/master/browser) - Shake Browser distribution
[/buildSrc]((https://github.com/shakelang/shake/tree/master/buildSrc) - Build source for gradle
[/config]((https://github.com/shakelang/shake/tree/master/config) - Containing various configuration files for different tools
[/gradle]((https://github.com/shakelang/shake/tree/master/config) - Containing the gradle wrapper
[/kotlin-js-store]((https://github.com/shakelang/shake/tree/master/kotlin-js-store) - Containing kotlin-js generated yarn.lock file
[/shake]((https://github.com/shakelang/shake/tree/master/shake) - Containing all shake-related code
[/util]((https://github.com/shakelang/shake/tree/master/util) - Containing all utility packages
[/webpack.config.d]((https://github.com/shakelang/shake/tree/master/webpack.config.d) - Required polyfills for webpack (required for kotlin.js compilation)