Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/planetdecred/godcr

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/planetdecred/godcr
Owner: planetdecred
License: isc
Created: 2020-01-13T19:44:23.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-05-21T01:10:31.000Z (4 months ago)
Last Synced: 2024-05-22T12:32:07.310Z (4 months ago)
Language: Go
Size: 7.4 MB
Stars: 78
Watchers: 5
Forks: 47
Open Issues: 1
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

awesome-gio - godcr - platform desktop wallet for the Decred cryptocurrency. (Gio Core / Software built with Gio)

README

        # ⚠️ Development on Godcr has been discontinued, and efforts have now shifted to [Cryptopower](https://github.com/crypto-power/cryptopower)

# godcr

[![Build Status](https://github.com/planetdecred/godcr/workflows/Build/badge.svg)](https://github.com/planetdecred/godcr/actions)

[![Tests Status](https://github.com/planetdecred/godcr/workflows/Tests/badge.svg)](https://github.com/planetdecred/godcr/actions)

A cross-platform desktop [SPV](https://docs.decred.org/wallets/spv/) wallet for [decred](https://decred.org/) built with [gio](https://gioui.org/).

## Building

Note: You need to have [Go 1.16](https://golang.org/dl/) or above to build.

Then `go build`.

### Linux

To build **godcr** on Linux these [gio dependencies](https://gioui.org/doc/install/linux) are required.

Arch Linux:

`pacman -S vulkan-headers libxkbcommon-x11`

## FreeBSD

To build **godcr** on FreeBSD you will need to `pkg install vulkan-headers` as root. This is a gio dependency.

## Running godcr

### General usage

By default, **godcr** runs on Mainnet network type. However, godcr can run on testnet by issuing commands on the terminal in the format:

```bash

godcr [options]

```

- Run `./godcr --network=testnet` to run godcr on the testnet network.

- Run `godcr -h` or `godcr help` to get general information of commands and options that can be issued on the cli.

- Use `godcr  -h` or   `godcr help ` to get detailed information about a command.

## Profiling 

Godcr uses [pprof](https://github.com/google/pprof) for profiling. It creates a web server which you can use to save your profiles. To setup a profiling web server, run godcr with the --profile flag and pass a server port to it as an argument.

So, after running the build command above, run the command

`./godcr --profile=6060`

You should now have a local web server running on 127.0.0.1:6060.

To save a profile, you can simply use

`curl -O localhost:6060/debug/pprof/profile`

## Contributing

See [CONTRIBUTING.md](https://github.com/planetdecred/godcr/blob/master/.github/CONTRIBUTING.md)

## Other

Earlier experimental work with other user interface toolkits can be found at [godcr-old](https://github.com/raedahgroup/godcr-old).