2019-05-05 13:34:21 +02:00
|
|
|
# ocean-balance
|
|
|
|
|
|
2019-05-06 01:04:17 +02:00
|
|
|
> 🐡 Simple Electron-based desktop app to retrieve and display your total Ocean Token balances.
|
2019-05-06 00:10:28 +02:00
|
|
|
> https://oceanprotocol.com
|
2019-05-05 13:34:21 +02:00
|
|
|
|
2019-05-06 01:04:17 +02:00
|
|
|
---
|
|
|
|
|
|
|
|
|
|
- [Usage](#usage)
|
|
|
|
|
- [Build packages](#build-packages)
|
|
|
|
|
- [Data Sources](#data-sources)
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
2019-05-05 13:34:21 +02:00
|
|
|
## Usage
|
|
|
|
|
|
2019-05-06 00:10:28 +02:00
|
|
|
Clone, add adresses, and run:
|
2019-05-05 13:34:21 +02:00
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
# Clone this repository
|
|
|
|
|
git clone git@github.com:kremalicious/ocean-balance.git
|
|
|
|
|
cd ocean-balance
|
|
|
|
|
|
2019-05-06 00:10:28 +02:00
|
|
|
# Add one or more Ethereum addresses to config file
|
|
|
|
|
vi config.js
|
|
|
|
|
|
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
|
|
|
|
|
npm run build
|
|
|
|
|
```
|
2019-05-06 01:04:17 +02:00
|
|
|
|
|
|
|
|
Will build and package the app into platform specific packages for macOS, Windows & Linux.
|
|
|
|
|
|
|
|
|
|
On a Mac and Linux machine, packaging requires [`wine`](https://www.winehq.org) in your `PATH`. To install on macOS with [Homebrew](https://brew.sh):
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
brew install wine
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Data Sources
|
|
|
|
|
|
|
|
|
|
- balances are checked via etherscan.io API
|
|
|
|
|
- spot prices are fetched from coingecko.com API
|
