Skip to content

Commit

Permalink
- added networking setup to README docs for local dev
Browse files Browse the repository at this point in the history
  • Loading branch information
rodvar committed Dec 10, 2024
1 parent 0e688da commit 1c1ea72
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
- [Project dev requirements](#project-dev-requirements)
- [Getting started](#getting-started)
- [Getting started for Android Node](#getting-started-for-android-node)
- [Local Env Setup](#localenv)
- [UI](#ui)
- [Designs](#designs)
- [Navigation Implementation](#navigation-implementation)
Expand Down Expand Up @@ -84,6 +85,24 @@ Addicionally, for the `androidNode` module to build you need to have its depende

Done! Alternatively if you are interested only in contributing for the `xClients` you can just build them individually instead of building the whole project.

### Local Env Setup

**Node**

You just need to run a local bisq seed node from the bisq2 project. By default port 8000 is used

**Clients**

You need to run the seed node as explained above + the http-api module with the following VM parameters

```
-Dapplication.appName=bisq2_restApi_clear
-Dapplication.network.supportedTransportTypes.2=CLEAR
-Dapplication.devMode=true
```

Default networking setup for the WebSocket (WS) connection can be found in `gradle.properties` file. If you need to override locally just use `local.properties` as in any gradle project.

### UI

**Designs**
Expand Down

0 comments on commit 1c1ea72

Please sign in to comment.