Skip to content

Latest commit

 

History

History
65 lines (38 loc) · 2.09 KB

settingUp.md

File metadata and controls

65 lines (38 loc) · 2.09 KB
Raw

Development Environment

Install prerequisites

IntelliJ IDEA (14 or later) is the recommended IDE.

Check out master

Development of HubTurbo moves fairly quickly. The master branch is generally always slightly ahead of the released version and contains features which will go into the next version, so you should check it out and build it to get started.

Build the project

IntelliJ IDEA

Import the project:

  1. File > Import project
  2. Select project directory
  3. Import project from existing model > Gradle
  4. Next
  5. Choose where you want project files to be located
  6. Finish

Run HubTurbo:

  1. Navigate > Class > UI
  2. Run > Run

Gradle

Gradle is the default way to build HubTurbo.

Given a fresh clone of the repository, run

Windows

./gradlew.bat shadowJar

OS X/Linux

./gradlew shadowJar

in the root directory. This will download a local copy of Gradle, then build an executable jar file.

  • On Windows, Gradle may take up significant memory while running. Close the window when the tasks are done to release it.

The executable jar will be in build/libs/HubTurbo-x.x.x-all.jar. Double-click that file to run it.

More details on Gradle usage here.

Start contributing

If you have not used HubTurbo before, the User Guide details its ins and outs. Be sure to give it a quick read and try out its features first!

After that, check out the documentation on design for an overview of the codebase and why it's the way it is. You'll need information on day-to-day workflow, as well as the coding and testing guidelines, when you're ready to write some code.

To get your work integrated, check out how the development process works.