Cloning ghost2

If you know how to fork, clone, and import a Gradle project from GitHub, you can safely skip this section. Otherwise, read on.

Preparation

Getting started with ghost2 is a simple step-by step process. I'll be using IntelliJ IDEA for any examples, as it's my IDE of choice and (arguably) the most popular IDE on the market for Java. If you'd like to use a different IDE, feel free to, but you'll have to work out the equivalent process yourself.

ghost2 is built with Java 11. Make sure you have a copy of the Java 11 JDK present on your system. AdoptOpenJDK is generally considered the best OpenJDK distributor by most, and they have builds available for every major OS and architecture.

It is also assumed that you already have Git installed on your system. If not, go to this page and download the appropriate installer for your platform.

Steps

1. To begin, you'll want to fork ghost2 so you can push to your own repository. Click the Fork button located at the top right of the project page and wait until you see your fork's page.

2. Click the Clone or download button and copy the link to your repository.

3. Open up IntelliJ and navigate to the welcome page. Click Check out from Version Control, paste in the repository URL, and click Clone. Wait for Git to finish cloning

4. IntelliJ will ask you if you want to open the project. Click Yes. An Import project from Gradle window should pop up.

5. Set the Gradle JVM to your JDK 11 directory. If you would like to, enable auto-import. Leave the other settings as they are, and click OK.

6. (Optional) Set JAVA_HOME and/or point your PATH to your JDK 11 directory if you want to be able to generate packaged builds with ghostPackage.

7. Wait for the Gradle wrapper to download a Gradle distribution, resolve dependencies, build, and sync. This may take anywhere from 30 seconds to 10 minutes depending on what you already have downloaded/cached and how fast your network is. After that, you're done!