Giter Club home page Giter Club logo

crypto-portfolio-tracker's Introduction

Crypto Portfolio Tracker (WIP)

Sponsor TypeScript version Node.js version APLv2

πŸ‘©πŸ»β€πŸ’» CLI based tool to fetch balances from all supported protocols from Zapper formatted to JSON and exported to CSV or Google Spreadsheet Node.js projects.

πŸƒπŸ½ Instant Value: All basic tools included and configured:

  • TypeScript 4.5
  • ESLint with some initial rules recommendation
  • Jest for fast unit testing and code coverage
  • Type definitions for Node.js and Jest
  • Prettier to enforce consistent code style
  • NPM scripts for common operations
  • Simple example of TypeScript code and unit test
  • .editorconfig for consistent file format
  • Reproducible environments thanks to Volta

🀲 Free as in speech: available under the APLv2 license.

Getting Started

This project is intended to be used with the latest Active LTS release of Node.js.

Clone repository

To clone the repository, use the following commands:

git clone https://github.com/ankurdaharwal/crypto-portfolio-tracker
cd crypto-portfolio-tracker
yarn install

Environment Setup

cp .env.example .env

Enter the API keys and Spreadsheet ID (For Google Spreadsheet)

# Google Spreadsheet API and Sheet ID
GOOGLE_API=
SHEET_ID=

# ZAPPER API KEY
ZAPPER_API=

Available Scripts

  • start - start the project
  • clean - remove coverage data, Jest cache and transpiled files,
  • prebuild - lint source files and tests before building,
  • build - transpile TypeScript to ES6,
  • build:watch - interactive watch mode to automatically transpile source files,
  • lint - lint source files and tests,
  • test - run tests,
  • test:watch - interactive watch mode to automatically re-run tests

Running the project

  • yarn start -a <ETHEREUM ACCOUNT ADDRESS> - start the project

Additional Utility Scripts

  • Prerequisite JQ formatter: npm i -g jq

  • Query Balances and Display JSON output

cd scripts
. ./zapper.sh -a<ETHEREUM ACCOUNT ADDRESS>
cat <ETHERUM ACCOUNT ADDRESS>.json | jq

Why include Volta

Volta’s toolchain always keeps track of where you are, it makes sure the tools you use always respect the settings of the project you’re working on. This means you don’t have to worry about changing the state of your installed software when switching between projects. For example, it's used by engineers at LinkedIn to standardize tools and have reproducible development environments.

I recommend to install Volta and use it to manage your project's toolchain.

Writing tests in JavaScript

Writing unit tests in TypeScript can sometimes be troublesome and confusing. Especially when mocking dependencies and using spies.

This is optional, but if you want to learn how to write JavaScript tests for TypeScript modules, read the corresponding wiki page.

Backers & Sponsors

Support this project by becoming a sponsor.

License

Licensed under the APLv2. See the LICENSE file for details.

crypto-portfolio-tracker's People

Contributors

ankurdaharwal avatar

Watchers

 avatar  avatar

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.