This guide will walk you through setting up the Elements Local SDK on an Ubuntu-based system. You’ll install the required dependencies manually or use the provided setup script for convenience.
🛠 Manual Step-by-Step Installation #
1. Install OpenJDK #
Install OpenJDK 21(or later):
sudo apt update
sudo apt install openjdk-21-jdk -y
Verify the installation:
java -version
2. Install Maven #
Install Maven using APT:
sudo apt install maven -y
Verify the installation:
mvn -version
3. Install Git (if not already installed) #
sudo apt install git -y
4. Install IntelliJ IDEA (Optional but Recommended) #
You can install IntelliJ IDEA via Snap:
sudo snap install intellij-idea-community --classic
Or download from:
👉 https://www.jetbrains.com/idea/download/
5. Clone and Import the Example Project #
Clone the Elements example project:
git clone https://github.com/NamazuStudios/element-example.git
Then:
- Open IntelliJ IDEA
- Click Open and select the
element-exampledirectory - If prompted, import as a Maven project
- If not prompted, right-click
pom.xmland select Add as Maven Project
6. Run the Local SDK #
- In IntelliJ, navigate to the
dev.getelements.sdk.localpackage - Locate and run the
LocalSdkMainclass (or the appropriate main class) - The local server should boot up and be accessible for testing
⚡ Full Setup Script (For Convenience) #
To install everything in one shot, run the following in a terminal:
sudo apt update
sudo apt install openjdk-21-jdk maven git -y
To install IntelliJ (optional):
sudo snap install intellij-idea-community --classic
✅ You’re Ready #
Once you’ve completed the setup:
- You can build and run the Elements example project locally
- You’re now ready to begin backend development using the Elements SDK

