benmarten / CryptoETF

Portfolio Overview Tool for Your CryptoCoin Capitalization-Weighted Portfolio.
Apache License 2.0
397 stars 77 forks source link
capitalization-weighted cli coin crypto cryptocoins etf node portfolio

CryptoETF

DISCLAIMER: This tool neither is, nor should be construed as an offer, solicitation, or recommendation to buy or sell any cryptoassets.

A CLI app, that pulls the cryptocoin balances from your exchanges and displayes your portoflio in comparison to the overall market. A recommendation is shown based on the ideal capitalization-weighted portfolio.

Installation

npm install
npm run build
cp settings.example.json settings.json

Usage

Run the sample: node sample Edit settings.json with your exchange api keys, then: node index

Exchanges

CryptoETF has API integrations with the following exchanges:

With these exchanges, you can easily build yourself your own CryptoETF.

Settings

The tool expects your settings in settings.json. Take a look at settings.example.json for a starting point.

Test

Contributing

Please send PR's to the develop branch!

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request to the develop branch :D

Releasing

git checkout develop
git flow release start "1.6.2"
git rebase master
npm run test
npm --no-git-tag-version version 1.6.2
git flow release finish "1.6.2"
git push
git checkout master && git push && git push --tags

License

See LICENSE.md

Donate