README

Contributing

Languages

asdf and direnv are suggested, but you can use whatever you'd like to get

• Java
• Ktlint
• NodeJs
• Python

versions are committed in .tool-versions, simply following the major versions there will work.

add a way to export these to your PATH in your ~/.profile so that commit hooks in your IDE works.

Build Tools

• Gradle
• Yarn 4 (via Corepack)

Fetching Dependencies

In order to get snapshots of dependencies, you must have a GitHub token in your ~/.gradle/gradle.properties file. This file should look like:

ghUsername = <your username>
ghPassword = <your token>

You should generate your PAT as Github Documents here.

a personal access token (classic) with at least read:packages scope to install packages associated with other private repositories (which GITHUB_TOKEN can't access).

Then run.

# Enable Corepack, install Node dev tools, run postinstall, then verify Gradle deps
corepack enable
yarn install --immutable --inline-builds --check-resolutions
yarn run -T postinstall
./gradlew dependencies

If you need to run the postinstall step directly, you can recreate and use the Python lock file via pip-compile (PEP 621):

# Regenerate requirements.txt from PEP 621 dependencies in pyproject.toml
pip-compile -o requirements.txt pyproject.toml

# Then install and set up commit hooks
pip install -r requirements.txt && git config core.hooksPath .config/git/hooks

Committing

Use Conventional Commits.

Licenses

• Java: SPDX-Identifier( AGPL-3.0-or-later WITH Universal-FOSS-exception-1.0 AND CC BY 4.0 ) OR CC-BY-NC-4.0
  For clarity the intent here is to maintain this software for any open source and non-commercial use. Attribution is required. If you would like to use this for commercial purposes please contact me.
• Gradle Kotlin and Config Files: MIT
• Documentation including Javadoc: CC-BY-NC-4.0

Copyright © 2025 Caleb Cushing.