mirror of https://github.com/bisq-network/bisq.git synced 2024-11-19 01:41:11 +01:00

As a follow-on to the monorepo reconsolidation (#1650):

 - Revise and shorten "What is Bisq" section
 - Remove outdated sections
 - Remove sections documented elsewhere
 - Add instructions for building, running and importing into IDEA

2018-09-07 15:21:56 +02:00

2.9 KiB

Raw Blame History

Bisq

What is Bisq?

Bisq is a safe, private and decentralized way to exchange bitcoin for national currencies and other cryptocurrencies. Bisq uses peer-to-peer technology and multi-signature escrow to facilitate trading without the need for a centralized third party exchange. Bisq is non-custodial (never holds your funds), and incorporates a human arbitration system to resolve disputes.

For more information, see https://bisq-network/intro and for step-by-step getting started instructions, see https://bisq.network/get-started.

Building Bisq

You will need JDK 8 installed to complete the following instructions.

Clone the Bisq source code and cd into bisq

 git clone https://github.com/bisq-network/bisq
 cd bisq

Build Bisq

You do not need to install Gradle to complete the following command. The gradlew shell script will install it for you if necessary.
```
 ./gradlew build
```

Running Bisq

With the above build complete, the Bisq executable jar is now available in the desktop/build/libs/ directory. Run it as follows, replacing {version} with the actual version found in the filename:

java -jar desktop/build/libs/desktop-{version}-all.jar`

Importing Bisq into Intellij IDEA

The following instructions have been tested on IDEA 2017.3

Go to Import Project, select settings.gradle and click Open
In the Import Project from Gradle screen, check the Use auto-import option and click OK
When prompted whether to overwrite the existing .idea directory, click Yes
Go to Preferences->Build, Execution, Deployment->Compiler->Annotation Processors and check the Enable annotation processing option (to enable processing of Lombok annotations)
In the Project tool window, right click on the root-level .idea folder, select Git->Revert... and click OK in the dialog that appears (to restore source-controlled .idea configuration files that get overwritten during project import)
Go to Help->Edit Custom Properties..., add a line to the file that reads idea.max.intellisense.filesize=12500, then quit and restart IDEA (to handle Bisq's very large generated PB.java Protobuf source file)
Go to Build->Build project. Everything should build cleanly. You should be able to run tests, run main methods in any component, etc.

TIP: If you encounter compilation errors related to the io.bisq.generated.protobuffer.PB class, it is probably because you didn't run the full Gradle build above. You need to run the generateProto task in the common project. You can do this via the Gradle tool window in IDEA, or you can do it the command line with cd common; ./gradlew generateProto. Once you've done that, run Build->Build project again and you should have no errors.