clef-ui

module
v0.0.0-...-d59d07f Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 7, 2020 License: GPL-3.0

README

Clef UI

UI Implementation for Clef, the geth-based signer.

It starts the signer binary as a subprocess, and communicates with the signer over standard input/output. The signer opens an external API to receive RPC request. Once a request comes in, the signer will then inform the UI via Standard I/O.

Getting Started

This UI uses a QT binding for Go to create the UI. To start building, you will first need to install thereceipe/qt, which comes with a CLI for compiling QT codes, and a WYSIWIG editor for QML. The installation process takes about 25 to 35 minutes.

Environment Setup

After installing thereceipe/qt, you will need to install the dependencies by running:

make deps

Since this is the first time you are building the UI, you will then need to compile all QT-related code by running the following. In the future, you will need to run this again if you change any QT-related code.

make deploy

You can then start the UI by running:

make run

License

This is licensed under GNU General Public License v3.0

Directories

Path Synopsis
cmd
internal
ui

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL