Most Bisq contributors use IDEA for development. The following instructions have been tested on IDEA 2018.2.
- Follow the instructions in build.md to clone and build Bisq at the command line.
- Open IDEA
- Go to
Help->Edit Custom Properties...
, add a line to the file that readsidea.max.intellisense.filesize=12500
(to handle Bisq's very large generatedPB.java
Protobuf source file) - Go to
Preferences->Plugins
. Search for and install the Lombok plugin. When prompted, do not restart IDEA. - Go to
Preferences->Build, Execution, Deployment->Compiler->Annotation Processors
and check theEnable annotation processing
option (to enable processing of Lombok annotations) - Restart IDEA
- Go to
Import Project
, select thesettings.gradle
file and clickOpen
- In the
Import Project from Gradle
screen, check theUse auto-import
option and clickOK
- When prompted whether to overwrite the existing
.idea
directory, clickYes
- In the
Project
tool window, right click on the root-level.idea
folder, selectGit->Revert...
and click OK in the dialog that appears (to restore source-controlled.idea
configuration files that get overwritten during project import) - Go to
Build->Build Project
. Everything should build cleanly. You should be able to run tests, runmain
methods in any component, etc.
TIP: If you encounter compilation errors in IDEA related to the
io.bisq.generated.protobuffer.PB
class, it is probably because you didn't build Bisq at the command line as instructed above. You need to run thegenerateProto
task in thecommon
project. You can do this via the Gradle tool window in IDEA, or you can do it the command line with./gradlew :common:generateProto
. Once you've done that, runBuild->Build Project
again and you should have no errors.