Skip to content

Building from source

This document provides instructions on how to build the project from source code. Follow the steps below to set up your development environment and compile the project.

You may have a variety of reasons to build the project from source, such as:

  • Customizing the app to your needs
  • Contributing to the project
  • Testing new features or bug fixes
  • Learning about the project's internals
  • Ensuring compatibility with your specific environment

Install IntelliJ

To begin, install IntelliJ. You can use either the Community or Ultimate edition.

Clone from source

If you are wanting to contribute changes to the source code, you should fork the GitHub repository first using your GitHub account. You can find more information on forking on this GitHub Docs page.

If you do not plan to submit your changes, you can clone the base repository.

At the IntelliJ home screen, click Get from VCS. In the URL field, enter the URL of the repository to clone. This is either the URL of your forked repository, or the base repository: https://github.com/wyskoj/midis2jam2. Click Clone.

Find more information on Git cloning on this IntelliJ help page.

Configure the project

After cloning the repository, IntelliJ needs to be configured to build and run the app.

Select the JDK

IntelliJ needs to know what Java Development Kit to use.

First, enter the File | Project Structure window. Next to SDK, select a JDK that is at least version 21. If you do not have a JDK installed, select Add SDK | Download JDK. Select 21 as the version, and Azul Zulu as the vendor. Click Download, then choose it in the list. Click OK to save changes.

Find more information on selecting a JDK on this IntelliJ help page.

Create a run configuration

IntelliJ needs to know how to start the app.

First, enter the Run | Edit Configurations window. Click Add new run configuration, and select Gradle. In the Tasks and arguments field, type run. Then, type midis2jam2 into the Gradle project field. Click OK to save changes.

Find more information on configuring a run configuration on this IntelliJ help page.

Reload Gradle projects

Finally, open the Gradle tab on the right side of the editor. Click the Reload All Gradle Projects button.

Starting the app

Press the Play button at the top of the screen to begin to app, or press Shift + F10.