Git-Mirrors/haveno
1
0
Fork 0
mirror of https://github.com/haveno-dex/haveno.git synced 2024-10-01 01:35:48 -04:00
Code Issues Packages Projects Releases Wiki Activity
47a7ec07e1
haveno/docs/import-haveno.md
woodser 47a7ec07e1 add developer guide and cleanup docs
2021-10-31 08:46:41 -04:00

3.4 KiB
Raw Blame History

Importing Haveno into development environment

This document describes how to import Haveno into an integrated development environment (IDE).

Importing Haveno into Eclipse IDE

The following steps describe how to import Haveno into Eclipse IDE for development. You can also develop using IntelliJ IDEA or VSCode if you prefer.

Note: Use default values unless specified otherwise.

  1. Download and run the Eclipse installer.
  2. Select "Eclipse IDE for Enterprise Java and Web Developers" to install.
  3. Launch an eclipse workspace and close out of the welcome screen.
  4. Download the latest version of the lombok jar.
  5. Run lombok jar, e.g.: java -jar ~/Downloads/lombok-1.18.22.jar.
  6. Follow prompts to install lombok to your Eclipse installation.
  7. Restart Eclipse.
  8. File > Import... > Existing Gradle Project.
  9. Select the location of "haveno" project, e.g. ~/git/haveno.
  10. Advance to finish importing haveno project.
  11. File > Import... > Existing Projects into Workspace.
  12. Select the location of "haveno-ui-poc" project, e.g. ~git/haveno-ui-poc.
  13. Advance to finish importing haveno-ui-poc project.

You are now ready to make, run, and test changes to the Haveno project!

Importing Haveno into IntelliJ IDEA

Note: These instructions are outdated and for Bisq.

Most Bisq contributors use IDEA for development. The following instructions have been tested on IDEA 2021.1.

  1. Follow the instructions in build.md to clone and build Bisq at the command line.
  2. Open IDEA
  3. Go to File -> Settings -> Build, Execution, Deployment -> Compiler -> Annotation Processors and check the Enable annotation processing option to enable processing of Lombok annotations (Lombok plugin installed by default since v2020.3)
  4. Go to File -> New -> Project from Existing Sources... and then select the main Bisq folder to load automatically the related Gradle project
  5. If you did not yet setup JDK11 in IntelliJ, go to File-> Project Structure -> Project and under the Project SDK option locate your JDK11 folder
  6. Select JDK 11 for Gradle as well. Go to File -> Settings -> Build, Execution, Deployment -> Build Tools -> Gradle and select the JDK11 location for the Gradle JVM value
  7. Go to Build -> Build Project. Everything should build cleanly
  8. Go to Run > Edit Configurations... -> Plus (+) icon on the top left -> Application anf then fill the requested fields as shown below, while using as CLI arguments one of those listed in dev-setup.md:

edit_configurations.png

  1. Now you should be able to run Bisq by clicking on the Play button or via Run -> Run 'Bisq Desktop'
  2. If you want to debug the application and execute breakpoints, use Run -> Debug 'Bisq Desktop'

TIP: If you encounter compilation errors in IDEA related to the protobuf.* classes, it is probably because you didn't build Bisq at the command line as instructed above. You need to run the generateProto task in the other project. You can do this via the Gradle tool window in IDEA, or you can do it the command line with ./gradlew :other:generateProto. Once you've done that, run Build -> Build Project again and you should have no errors.

If this does not solve the issue, try to execute ./gradlew clean and then rebuild the project again.