The Developer Setup Guide for an IntelliJ Workflow
This developer setup guide is the old developer setup guide for Legup. It is no longer actively updated. Please refer to the most recent developer setup guide before coming back to this one. This guide is intended for developers that are interested in doing everything within IntelliJ. Note that there may be steps from the newer setup guide that are applicable to this setup guide (such as the CheckStyle plugin setup). Please refer to the new setup guide for information on what steps are applicable.
The first thing that you will want to do is fork the main Legup repository. Press the "Fork" button on the top right side of the page. Once you have created your own fork, navigate to it, click the green "Code" button, then press the clipboard to copy your repository's link.
Once the link to your forked version has been copied, you must clone it onto your computer.
Doing so using IntelliJ is relatively simple, as all you need to do is press "Get from Version Control" once IntelliJ opens, paste in the URL you copied, and then press "Clone". After a few moments, IntelliJ should have downloaded all the Legup code (if on Windows, it should be stored in C:\Users\YOUR_USERNAME\IdeaProjects\Legup) and opened the coding window. In the bottom right hand corner, a popup will appear saying that it found a Gradle script. Gradle is a tool used by Legup to build the code. Press the "Import Gradle Project" button. After about a minute, IntelliJ will import the Gradle commands needed for Legup.
To verify that everything worked, press the "Project" button on the left sidebar followed by the "Legup" button (this shows you all the files and folders in the Legup project). Your window should look similar to this:
To run Legup, you must build the project into a .jar file and then run the newly made file.
Using IntelliJ, go to the Gradle window on the right side and run Legup > Tasks > build > jar. A terminal should appear at the bottom of the screen, and after a few minutes the terminal should print Task execution finished 'jar' (if the task never finishes successfully, you need to do some debugging). On the code navigation window, navigate to Legup/build/libs.
Right click the Legup.jar file and then press "Run 'Legup.jar'" to launch your build of Legup.
If you are not using IntelliJ, all you need to do is run the command gradlew.bat jar if you use Windows or the command gradlew jar if you use Linux. This will create the file Legup/build/libs/Legup.jar (same place as IntelliJ).
Once you are ready to add your changes to the main Legup repository, you need to commit your changes, push your changes to your forked repository, and then open a pull request on the main repository.
Committing and pushing your changes can be done within IntelliJ using the Git buttons on the right side of the top bar.
The leftmost blue arrow button can be used to update the project on your computer whenever somebody else makes changes to the project on GitHub. The middle green button is used to commit your changes. The rightmost green button is used to push your committed changes to your forked GitHub repository.
Since the first step is to commit your changes, press the commit button. A window will appear on the left that lists all the changes files as well as a text box to describe the changes you've made. Put a brief description of what you've done, and then press the "Commit" button at the bottom.
The next step is to push your changes. Press the push button. Like before, you will be presented with all the files that you've changed. Press the "Push" button at the bottom (you may be prompted to login to GitHub). After a few seconds, all your changes will be uploaded to your forked GitHub repository.
The final step is to open a pull request to merge the code from your repository into the main repository (NOTE: you can make multiple commits to your forked repo before opening a pull request, this step does not have to immediately follow the previous one). Open your forked version on GitHub and then press "Pull requests", followed by"New pull request", and then "Create pull request". Create a title for your request as well as a description of the changes. Finally, press "Create pull request". Pull requests must be approved by another maintainer in order to be merged, so all you need to do now is wait for somebody else to approve and then merge your request.
Legup uses Gradle to manage its build process. A wrapper script, gradlew, is included at the root of the repository. It should be executable by default, but if it isn't (e.g., you get a "permission denied" error with one of the subsequent steps), then you'll need to run chmod +x gradlew. To build the entire project, just run ./gradlew jar. This will build a Legup.jar file in the build/libs subdirectory. Open that file to run Legup. If you want to run Legup "in-place" (e.g., for debugging), then run ./gradlew run instead. This will automatically launch Legup, but a dedicated .jar executable will not be created.