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.
-
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, andcolors
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.
Here is demonstration of few commands
To get started with the Crypto-Coindex CLI tool, follow these steps:
- Clone the repository to your local machine.
- Install dependencies using
npm install
. - Run
npm link
for creating symbolic link for global command access. - Get an API key from the CoinAPI.
- 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!
- Brad Traversy (amazing man)
- CoinAPI (for providing API key for development purpose)