JSponaugle / wagerr-electron-app

Wagerr Electron App is a cross-platform GUI for Wagerr.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Note: The Wagerr Electron App is currently experimental and not expected to work with the current Wagerr Core release. An official beta release will be published soon.

Wagerr Electron App

Build Status

A modern cross-platform GUI for Wagerr built with Electron & Vue.js.

Prerequisites

Make sure you back up your Wagerr wallet.dat before developing on this app.

You need the following prerequisites to be able to build and develop the project on your local machine.

  • Node.js
  • npm

Install

Clone the repo:

git clone https://github.com/wagerr/wagerr-electron-app.git

Change directory into the cloned repository:

cd wagerr-electron-app

Install dependencies with npm:

npm install

Place wagerrd and wagerr-cli binaries in a bin directory in the the root of your repo:

mkdir bin

# Fetch the applicable release from https://github.com/wagerr/wagerr/releases
# for your OS and architecture and unzip the `wagerrd` and `wagerr-cli` binaries
# into the `bin` folder.

Development

Run in development mode:

npm run dev

Before submitting a patch we highly recommend running the linting and formatting scripts:

npm run lint-fix && npm run lint-styles-fix

Package for Distribution

To package the app for distribution (don't forget to copy the wagerrd and wagerr-cli binaries into the bin folder before packaging the app):

npm run package

After running the package command the executable will be located in the release folder.

Code Signing

To code sign the packaged app you must set the following environment variables before running npm run package.

macOS:

# macOS - Name of certificate to retrieve from Keychain
export CSC_NAME='Wagerr Limited'

Windows:

# Windows (PowerShell) - Path to *.pfx certificate relative to root of project
$env:CSC_LINK='build\WagerrLimited.pfx'

# Optional - The password to decrypt the certificate given in CSC_LINK
$env:CSC_KEY_PASSWORD='Password123!'

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

Licensed under the MIT License.

About

Wagerr Electron App is a cross-platform GUI for Wagerr.

License:MIT License


Languages

Language:Vue 49.8%Language:JavaScript 25.1%Language:CSS 24.9%Language:HTML 0.2%