Skip to content

Commit 81e4b3a

Browse files
link to existing build from source guide
Signed-off-by: Philemon Ukane <[email protected]>
1 parent 61c33df commit 81e4b3a

File tree

3 files changed

+3
-113
lines changed

3 files changed

+3
-113
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ Pick **just one** method:
100100
4. [Use Decrediton](https://docs.decred.org/wallets/decrediton/decrediton-setup/),
101101
the official graphical Decred wallet, which integrates Bison Wallet, and go
102102
to the DEX tab.
103-
5. Build the standalone client [from source](https://github.com/decred/dcrdex/wiki/Development-and-Contributing).
103+
5. Build the standalone client [from source](https://github.com/decred/dcrdex/wiki/Download-and-Install#building-from-source).
104104

105105
Almost everyone will just want the client to trade on existing markets, but if
106106
you want to set up a new DEX server and host markets of your choice, see

docs/wiki/Contribution-Guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Development is coordinated via [github issues](/../issues) and the
88
You can access the room at [chat.decred.org](https://chat.decred.org),
99
[riot.im](https://riot.im), or with any other Matrix client.
1010

11-
If you are yet to set up or want to build from source, please see [Development and Contributing](./Development-and-Contributing.md) for setup and build instructions.
11+
If you are yet to set up or want to build from source, please see [build from source guide](https://github.com/decred/dcrdex/wiki/Download-and-Install#building-from-source) for build instructions.
1212

1313
## Contributing code
1414

docs/wiki/Development-and-Contributing.md

Lines changed: 1 addition & 111 deletions
Original file line numberDiff line numberDiff line change
@@ -10,117 +10,7 @@ Before beginning work, chat with us in the
1010
The pace of development is pretty fast right now, so you'll be expected to keep
1111
your pull requests moving through the review process.
1212

13-
### Prerequisites for Bison Wallet Development
14-
15-
1. [Go 1.24 or later](https://golang.org/doc/install) is required.
16-
2. [Node 18 or later](https://nodejs.org/en/download/). Node.js is used to bundle resources for the browser interface. It's important to note that Bison Wallet has no external JavaScript dependencies. The client doesn't import any Node packages. We only use Node to lint and compile our own JavaScript and css resources but it's not required if building from a release branch such as `release-v0.6`.
17-
3. At least 2 GB of available system memory.
18-
4. (Optional) [Golangci-lint](https://golangci-lint.run/docs/welcome/install/) is recommended for linting Go code. Only required if you plan to contribute code.
19-
5. Optional: [Docker](https://docs.docker.com/get-docker/) is recommended for containerized development and testing.
20-
21-
### Preparation
22-
23-
- [Install Node.js 18.x or later](https://nodejs.org/en/download/), which is required to lint
24-
and package the static web assets.
25-
26-
- [Install Go 1.24 or later](https://golang.org/doc/install) and verify with:
27-
28-
```sh
29-
go env GOROOT GOPATH
30-
```
31-
Ensure `$GOPATH/bin` is on your `$PATH`.
32-
33-
- Clone the `dcrdex` repository via your terminal:
34-
35-
```sh
36-
git clone https://github.com/decred/dcrdex.git
37-
cd dcrdex
38-
```
39-
40-
### Building from Source
41-
42-
- Build the web assets
43-
44-
```sh
45-
cd client/webserver/site
46-
npm clean-install && npm run build
47-
```
48-
49-
This will generate the bundled CSS and JavaScript files in the *dist/* folder.
50-
51-
Alternatively, for development, `npm` can be made to watch for and integrate JavaScript source changes:
52-
53-
```sh
54-
npm run watch
55-
```
56-
57-
- Build and Run Bison Wallet
58-
59-
To build and run the Bison Wallet client, you have the option of building the `bisonw` or `bisonw-desktop` binary. First, ensure you are in the root of the git repository. If you've just built the web assets, you can return to the root with `cd ../../..`.
60-
61-
**For the browser client:**
62-
63-
```sh
64-
cd ./client/cmd/bisonw
65-
./bisonw
66-
```
67-
68-
Once running, open your browser and visit: `http://127.0.0.1:5758`.
69-
70-
**For the desktop client**, follow the instructions in [client/cmd/bisonw-desktop/README.md](../client/cmd/bisonw-desktop/README.md).
71-
72-
### Running with Docker
73-
74-
If you prefer containerized development, follow these steps to build and run Bison Wallet using Docker.
75-
76-
- Install Docker
77-
78-
Ensure Docker is installed on your machine. [Get Docker](https://docs.docker.com/get-docker/), open and set up it up. Then verify installation with:
79-
80-
```sh
81-
docker --version
82-
```
83-
84-
- Build Docker Image
85-
86-
Run this command from the root of the repository:
87-
88-
```sh
89-
docker build -t user/bisonw -f client/Dockerfile .
90-
```
91-
92-
- Create a Docker Volume
93-
94-
This creates a persistent data volume for the wallet:
95-
96-
```sh
97-
docker volume create --name=bisonw_data
98-
```
99-
100-
- Run the Docker Container
101-
Start the Bison Wallet container with:
102-
103-
```sh
104-
docker run -d -p 127.0.0.1:5758:5758 -v bisonw_data:/root/.bisonw user/bisonw
105-
```
106-
107-
Then, open your browser and visit: `http://127.0.0.1:5758`
108-
109-
You'll get the container ID as output. If you need to stop the container later, use:
110-
111-
```sh
112-
docker stop <container_id>
113-
```
114-
115-
To run the container again:
116-
117-
```sh
118-
docker container start <container_id>
119-
```
120-
121-
Your data will persist in the `bisonw_data` volume.
122-
123-
If you run into any issue during the build or run process, please reach out to us in the [DEX Development room](https://matrix.to/#/!EzTSRQITaqHuFBDFhM:decred.org?via=decred.org&via=matrix.org&via=zettaport.com) or open an issue on the [GitHub issues page](https://github.com/decred/dcrdex/issues).
13+
To learn about project requirements and how to build from source read the [build from source guide](https://github.com/decred/dcrdex/wiki/Download-and-Install#building-from-source).
12414

12515
### Additional Resources
12616

0 commit comments

Comments
 (0)