Skip to content

Node.js CLI tool for checking real time cryptocurrency prices.

Notifications You must be signed in to change notification settings

KumaarBalbir/crypto-coindex

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Crypto-Coindex

This project is a Node.js CLI tool for checking cryptocurrency prices. It utilizes various Node.js packages and the CoinAPI to provide real-time cryptocurrency data.

Description

  • Modules Used: The modules used in the project are commander for handling CLI commands, inquirer for user input prompts, config store for configuration management, axios for API requests, and colors for CLI output styling.

  • Command Functionality: Organized command functionality into separate files and folders for maintainability and modularity.

  • API Key Handling: Implemented a "key manager" class to handle set, get, and delete operations for API keys using config store.

  • User Input Validation: Utilized inquirer for prompting the user for an API key and implemented custom validation to ensure the key is not empty.

  • Error Handling: Implemented error handling for scenarios such as missing API keys or API request failures.

Demonstration

Here is demonstration of few commands

coindex

Main Command Screenshot

coindex key -h

help command

coindex key set

set command

coindex check price

price command

coindex check price --cur=EUR

price with currency

coindex check price --coin=BTC --cur=INR

price with coin and cur

Getting Started

To get started with the Crypto-Coindex CLI tool, follow these steps:

  1. Clone the repository to your local machine.
  2. Install dependencies using npm install.
  3. Run npm link for creating symbolic link for global command access.
  4. Get an API key from the CoinAPI.
  5. Open cmd prompt or powershell to explore the available commands (key, check, etc.) and check cryptocurrency prices (see attached screenshot).

Feel free to explore and customize it according to your requirements!

Credit

  • Brad Traversy (amazing man)
  • CoinAPI (for providing API key for development purpose)

About

Node.js CLI tool for checking real time cryptocurrency prices.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published