Giter VIP home page Giter VIP logo

mph-dock's Introduction

MPH Dock

MPH Dock is a lightweight Mac OS tray application that provides quick access to a Mining Pool Hub account overview.


The app sits in the top menu bar and shows the account balance of your auto-exchange coin. A full balance breakdown of all coins is shown upon selection.

screenshot

Built with Electron, uses the Mining Pool Hub API.

Install

Pre-built binary (recommended)

Download the latest stable build from releases. Run app and enter your API key. Select your Auto Exchange coin and, optionally, the interval the app will auto-refresh.

Build from source

git clone https://github.com/ipaulpro/mph-dock

Optional: Edit mph-dock/app/config.js to add your Mining Pool Hub API key, and specify the auto exchange coin you're currently using.

API_KEY: '', // Your Mining Pool Hub API key, found at https://miningpoolhub.com/?page=account&action=edit
AUTO_EXCHANGE: 'BTC' // The symbol of your Auto Exchange Coin (BTC, ETH, LTC, etc.)

Running

cd path/to/mph-dock
npm install
npm start

Packaging

npm run package
open out/MPH-Dock-darwin-x64/MPH Dock.app

Notes

Currently only Mac OS is supported, and the app is geared toward Mining Pool Hub Auto Exchange users.

Plans include:

  • Better support for users that don't use Auto Exchange
  • Look into Windows support
  • Add tab for Worker stats
  • Provide choices for menu bar display
  • Support for multiple MPH accounts

Feature and pull requests are welcome for these, and any other features in the Issue Tracker.

Credits

Created by Paul Burke

Acknowledgements

Inspired by, and uses code from Bitdock by Chris Underdown

Inspired by MiningPoolHubStats

Licenses

Copyright (C) 2017 Paul Burke

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Bitdock:

Copyright 2017 Chris Underdown

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.