vin-bekir/godcr

godcr

Overview

godcr is a decred wallet application for Desktop Operating Systems (Linux, macOS, Windows etc). dcrlibwallet, a standalone decred wallet library, is used for all wallet access and control functionality. godcr can also interface with dcrwallet over gRPC as an alternative to dcrlibwallet.

Requirements

You can run godcr without installing any other software.

However, to use dcrwallet instead of dcrlibwallet for wallet operations, you'll need a running dcrwallet daemon. Follow the steps below to download, setup and run dcrwallet:

• Download the decred release binaries for your operating system from here. Check under Assets.
• By default, dcrwallet uses dcrd to connect to the Decred network. The decred archive downloaded from the release page contains both binaries.
• After downloading and extracting dcrd and dcrwallet, go here to learn how to setup and run both binaries.

Installation

Option 1: Get the binary

godcr is not released yet. This doc will be updated with links to download the godcr binary when a release is ready. For now, build from source.

Option 2: Build from source

Step 1. Install Go

• Minimum supported version is 1.11.4. Installation instructions can be found here.
• Set $GOPATH environment variable and add $GOPATH/bin to your PATH environment variable as part of the go installation process.

Step 2. Clone this repo

It is conventional to clone to $GOPATH, but not necessary.

git clone https://github.com/raedahgroup/godcr $GOPATH/src/github.com/raedahgroup/godcr

Step 3. Build the source code

• If you cloned to $GOPATH, set the GO111MODULE=on environment variable before building. Run export GO111MODULE=on in terminal (for Mac/Linux) or setx GO111MODULE on in command prompt for Windows.
• cd to the cloned project directory and run go build or go install. Building will place the godcr binary in your working directory while install will place the binary in $GOPATH/bin.

Running godcr

General usage

By default, godcr runs as a cli app where various wallet operations are performed by issuing commands on the terminal in the format:

godcr [options] <command> [args]

• Run godcr -h or godcr help to get general information of commands and options that can be issued on the cli.
• Use godcr <command> -h or godcr help <command> to get detailed information about a command.

As a GUI app

godcr can also be run as a full GUI app where wallet operations are performed by interacting with a graphical user interface. The following GUI interface modes are supported:

1. Full GUI app on terminal. Run godcr --mode=terminal
2. Web app served over http or https. Run godcr --mode=http
3. Native desktop app with nuklear library. Run godcr --mode=nuklear

Configuration

The behaviour of the godcr program can be customized by editing the godcr configuration file. The config file is where you set most options used by the godcr app, such as:

• the host and port to use for the http web server (if running godcr with --mode=http)
• the default interface mode to run (if you're tired of having to set --mode= everytime you run godcr)
• whether or not to use dcrwallet over gRPC for wallet functionality

Run godcr -h to see the location of the config file. Open the file with a text editor to see all customizable options.

Features

Go here to view updated information about implemented features and known issues and workarounds.

Contributing

See the CONTRIBUTING.md file for details. Here's an overview:

1. Fork this repo to your github account
2. Before starting any work, ensure the master branch of your forked repo is even with this repo's master branch
3. Create a branch for your work (git checkout -b my-work master)
4. Write your codes
5. Commit and push to the newly created branch on your forked repo
6. Create a pull request from your new branch to this repo's master branch