blowfish/README.md

90 lines
2.8 KiB
Markdown
Raw Normal View History

2019-05-19 15:24:25 +02:00
<h1 align="center">
Blowfish
</h1>
<p align="center">
<strong>🐡 Simple Electron-based desktop app to retrieve and display your total <a href="https://oceanprotocol.com">Ocean Token</a> balances.</strong>
</p>
<p align="center">
<a href="https://travis-ci.com/kremalicious/blowfish"><img src="https://travis-ci.com/kremalicious/blowfish.svg?branch=master" /></a>
2019-05-20 22:46:17 +02:00
<a href="https://codeclimate.com/github/kremalicious/blowfish/maintainability"><img src="https://api.codeclimate.com/v1/badges/beeab7902ee5307fc0a1/maintainability" /></a>
2019-05-19 15:24:25 +02:00
<a href="https://greenkeeper.io/"><img src="https://badges.greenkeeper.io/kremalicious/blowfish.svg" /></a>
</p>
2019-05-05 13:34:21 +02:00
2019-05-19 15:24:25 +02:00
![interface](https://user-images.githubusercontent.com/90316/57982435-f0098a80-7a45-11e9-96c0-903830c8d42a.png)
<p align="center">
Made with ♥ by <a href="https://matthiaskretschmann.com">Matthias Kretschmann</a>
</p>
<p align="center">
<small>Say thanks with OCEAN or ETH: <code>0xf50F267b5689b005FE107cfdb34619f24c014457</code></small>
<br />
<small>Say thanks with BTC: <code>3DiHNMt875UWa2j73qFpr3cVB9foFhYArc</code></small>
</p>
2019-05-05 13:34:21 +02:00
2019-05-06 01:04:17 +02:00
---
2019-05-06 14:02:49 +02:00
- [Features](#features)
2019-05-19 15:24:25 +02:00
- [Download](#download)
- [Development](#development)
2019-05-06 01:04:17 +02:00
- [Build packages](#build-packages)
2019-05-19 15:24:25 +02:00
- [License](#license)
2019-05-06 01:04:17 +02:00
---
2019-05-06 14:02:49 +02:00
## Features
- show Ocean Token balances from a list of Ethereum account addresses
- show a total balance of all account balances
- convert those balances against multiple currencies
- re-fetches everything automatically every minute
- balances are fetched via etherscan.io API
- spot prices are fetched from coingecko.com API
2019-05-19 23:13:09 +02:00
- detects system locale for number formatting
- detects dark appearance setting and switches to dark theme automatically (macOS only)
- detects system accent color and uses it as primary color (macOS & Windows only)
2019-05-19 15:24:25 +02:00
- currently highly optimized for macOS, your mileage on Windows or Linux may vary
## Download
You can download pre-built binaries for macOS, Linux, and Windows from the [Releases page](https://github.com/kremalicious/blowfish/releases).
The binaries are not code-signed so opening them on macOS will result in a warning. To be able to get around this warning:
2019-05-06 14:02:49 +02:00
2019-05-19 15:24:25 +02:00
1. Right-click on the app icon, and choose _Open_
2. In the dialog, click _Open_
2019-05-05 13:34:21 +02:00
2019-05-19 15:24:25 +02:00
Alternatively, you can [build the app on your system](#build-packages).
## Development
Clone, and run:
2019-05-05 13:34:21 +02:00
```bash
# Clone this repository
2019-05-19 15:24:25 +02:00
git clone git@github.com:kremalicious/blowfish.git
cd blowfish
2019-05-05 13:34:21 +02:00
# Install dependencies
npm install
# Run the app in dev mode
npm start
```
2019-05-06 01:04:17 +02:00
## Build packages
2019-05-05 13:34:21 +02:00
```bash
2019-05-19 15:24:25 +02:00
npm run dist
2019-05-05 13:34:21 +02:00
```
2019-05-06 01:04:17 +02:00
Will build and package the app into platform specific packages for macOS, Windows & Linux.
2019-05-19 15:24:25 +02:00
On a Mac and Linux machine, packaging requires [`wine`](https://www.winehq.org) and `rpm` in your `PATH`. To install on macOS with [Homebrew](https://brew.sh):
2019-05-06 01:04:17 +02:00
```bash
2019-05-19 15:24:25 +02:00
brew install wine rpm
2019-05-06 01:04:17 +02:00
```
2019-05-19 15:24:25 +02:00
## License
[The MIT License](./LICENSE)