Skip to main content

Requirements

System Requirements​

Before getting started with the SOKit and SOKit UI frameworks, make sure your development environment meets the following prerequisites. This guide focuses primarily on macOS, but the steps can be adapted for other platforms.

We recommend using SDKMAN! to manage Java versions in a flexible and efficient way. SDKMAN! allows easy installation and switching between multiple JDK versions.

To install SDKMAN!, run:

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

Step 2: Install Eclipse Temurin JDK 21​

SOKit requires Eclipse Temurin JDK 21, which is a distribution of OpenJDK maintained by the Eclipse Foundation. Gradle explicitly expects this version to ensure compatibility and consistent builds.

✅ Using SDKMAN! (Recommended)​

Once SDKMAN! is installed, you can install Temurin JDK 21 by running:

sdk install java 21-tem

After installation, verify the version:

java -version

You should see something like:

openjdk version "21.0.5" 2024-02-05
OpenJDK Runtime Environment Temurin-21.0.5

🛠 Alternative: Install via Homebrew (macOS)​

If you're on macOS and prefer using Homebrew, you can install Eclipse Temurin JDK 21 with the following command:

brew install --cask temurin@21

After installation, set it as your default Java version:

export JAVA_HOME=$(/usr/libexec/java_home -v 21)
source ~/.zshrc  # or ~/.bashrc, depending on your shell

Then confirm the version:

java -version

For more details, refer to the Homebrew Temurin documentation.

Step 3: Install a Container Manager​

The SOKit Initializer runs in a containerized environment, so you'll need a container manager installed on your machine.

We recommend using Docker Desktop, which offers a user-friendly interface for managing containers.

Alternatively, you may use other container solutions like Podman.

⚠️ Make sure your container manager is running before proceeding with the SOKit Initializer.

Step 4: Install Node.js​

To use the SOKit UI framework, you'll need Node.js version 18.0 or later. You can download it directly from the official site:

👉 Download Node.js

During installation, make sure to enable any options related to installing dependencies or development tools (such as npm).

You can verify the installation by running:

node -v
npm -v

Once these requirements are met, you’ll be ready to initialize your first SOKit application.