Alternative Developer Setup Guide (Linux)

Developer setup guide aimed to help linux users get set up and ready to contribute to LEGUP.

In this setup we are assuming the use of Ubuntu (although any Debian based Distro will have the same commands) and using Git, Gradle, and neovim as text editor (but any other text editor would work, some good options are Visual Studio Code and Sublime Text.

required software:

• Git (you can also install Github desktop if you wish)
• Java (v21) (yes the version matters)
• Gradle
• Text editor (this guide uses neovim but any text editor will work)

1. Installing text editor

---

The first step of any software installation process on linux should be a quick package update, so open your terminal and enter the following command:

sudo apt udpate

to install neovim enter the following commands

sudo apt install snapd

sudo snap install nvim --classic

2. Installing Git

sudo apt install git

3. Installing Java

even if you already have java on your system you may need to check your version with the "java -version" command, to contribute to legup you will need java 21, which you can get through the following commands:

sudo apt install openjdk-21-jdk -y

wget https://download.oracle.com/java/21/latest/jdk-21_linux-x64_bin.deb

sudo apt install ./jdk-21_linux-x64_bin.deb

now entering "java -version" should show openjdk version "21.0.3"

4. Installing Gradle

sudo apt install curl

curl -s "https://get.sdkman.io" | bash

source "$HOME/.sdkman/bin/sdkman-init.sh"

sdk install gradle

5. Forking the repository

6. Downloading the project

git clone "https://github.com/*YOUR USERNAME*/YOUR FORK OF LEGUP"

if you experience any errors when cloning the repository, like an authentication error, you might need to add a github ssh key to your home directory/.ssh, if not there, create a folder called .ssh in your home directory, open the terminal at that location and enter the following command: ssh-keygen -t ed25519 -C "[email protected]"

you will then need to open the file and add it to your github account in security/ssh keys

7. Opening the project with your text editor

go to where the project is, go to the directory where the files are then do

nvim filename

to exit and save in neovim you must do Esc, :, w, q, Enter

8. running legup

to run legup, you have to go to the directory where the "build.gradle file is" assuming you cloned the repository into your Documents/GitHub directory, you should go to (you can do cd and the following directory) ~/Documents/GitHub/YOUR FORKED REPO and enter

./gradlew build

and to run with

./gradlew run