Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/scala-network/GUI-miner

An easy to use GUI miner available for Windows, macOS and Linux
https://github.com/scala-network/GUI-miner

Last synced: 12 days ago
JSON representation

An easy to use GUI miner available for Windows, macOS and Linux

Awesome Lists containing this project

README

        

![](git-assets/miner-logo.png)

# Scala GUI Miner

The Scala GUI miner is a beautiful, easy to use, interface for mining Scala.
It is aimed at getting people that have never mined Scala into the crypto
game by making it really simple to get started.

![Screenshot](https://i.imgur.com/ruK7z4Y.png "Screenshot")

We currently support one very popular miner backend:

1. [xlarig](https://github.com/scala-network/xlarig)

If you'd like to fork this miner for you own coin, please see the __forking__
section later.

## Compiling

### Linux

The miner GUI is built using [Electron](https://electronjs.org) and
[Go](https://golang.org) using the
[Astilectron app framework](https://github.com/asticode/astilectron).

* Install Go

[https://golang.org/dl/](https://golang.org/dl/)

* Clone the repository

```shell
git clone https://github.com/scala-network/gui-miner gui-miner
cd gui-miner
```

* Initialize the go project

```shell
go mod init gui-miner
```

* Install the required Go packages

```shell
go get -u github.com/asticode/go-astilectron@latest
go install github.com/asticode/go-astilectron
go get -u github.com/asticode/go-astilectron-bundler/...
go install github.com/asticode/go-astilectron-bundler/astilectron-bundler
go get -u github.com/asticode/go-astichartjs@latest
go install github.com/asticode/go-astichartjs
go get -u github.com/asticode/go-astilectron-bootstrap@latest
go install github.com/asticode/go-astilectron-bootstrap
go get -u github.com/google/uuid@latest
go install github.com/google/uuid
go get -u github.com/mitchellh/go-ps@latest
go install github.com/mitchellh/go-ps
go get -u github.com/scala-network/gui-miner/src/gui@latest
```

* Build the app

```shell
make
```

NOTE: Ensure you clone the GUI miner into your working $GOPATH

If all goes well the binaries for Windows, macOS and Linux will be available in the `bin` folder.

## Forking

In the spirit of open source we'll be making it really simple to fork and
brand the miner for your own coin. Some structural changes need to be made to
simplify the process. Subscribe to issue [#3][i3] to follow the progress on this
guide.

[i3]: https://github.com/scala-network/gui-miner/issues/3