{"id":26829512,"url":"https://github.com/kumaarbalbir/crypto-coindex","last_synced_at":"2025-03-30T13:17:09.567Z","repository":{"id":230252091,"uuid":"778852758","full_name":"KumaarBalbir/crypto-coindex","owner":"KumaarBalbir","description":"Node.js CLI tool for checking real time cryptocurrency prices.","archived":false,"fork":false,"pushed_at":"2024-03-28T16:11:21.000Z","size":99,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-03-28T17:31:35.230Z","etag":null,"topics":["cli-app","commanderjs","nodejs"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KumaarBalbir.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-03-28T14:36:31.000Z","updated_at":"2024-03-28T17:31:44.584Z","dependencies_parsed_at":"2024-03-28T17:31:37.840Z","dependency_job_id":"76579fea-cd47-4bc9-8246-dd9f5ba16949","html_url":"https://github.com/KumaarBalbir/crypto-coindex","commit_stats":null,"previous_names":["kumaarbalbir/crypto-coindex"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KumaarBalbir%2Fcrypto-coindex","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KumaarBalbir%2Fcrypto-coindex/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KumaarBalbir%2Fcrypto-coindex/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KumaarBalbir%2Fcrypto-coindex/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KumaarBalbir","download_url":"https://codeload.github.com/KumaarBalbir/crypto-coindex/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246320185,"owners_count":20758410,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli-app","commanderjs","nodejs"],"created_at":"2025-03-30T13:17:09.004Z","updated_at":"2025-03-30T13:17:09.556Z","avatar_url":"https://github.com/KumaarBalbir.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Crypto-Coindex\n\nThis project is a Node.js CLI tool for checking cryptocurrency prices. It utilizes various Node.js packages and the [CoinAPI](https://docs.coinapi.io/) to provide real-time cryptocurrency data.\n\n## Description\n\n- **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.\n\n- **Command Functionality**: Organized command functionality into separate files and folders for maintainability and modularity.\n\n- **API Key Handling**: Implemented a \"key manager\" class to handle set, get, and delete operations for API keys using `config store`.\n\n- **User Input Validation**: Utilized `inquirer` for prompting the user for an API key and implemented custom validation to ensure the key is not empty.\n\n- **Error Handling**: Implemented error handling for scenarios such as missing API keys or API request failures.\n\n## Demonstration\nHere is demonstration of few commands\n#### coindex\n![Main Command Screenshot](assets/coindex.png) \n\n#### coindex key -h \n![help command](assets/coindex%20key%20-h.png) \n\n#### coindex key set\n![set command](assets/coindex%20key%20set.png) \n\n#### coindex check price\n![price command](assets/coindex%20check%20price.png)\n\n#### coindex check price --cur=EUR\n![price with currency](assets/coindex%20check%20price%20cur.png)\n\n#### coindex check price --coin=BTC --cur=INR\n![price with coin and cur](assets/coindex%20check%20price%20coin.png)\n\n## Getting Started\n\nTo get started with the Crypto-Coindex CLI tool, follow these steps:\n\n1. Clone the repository to your local machine.\n2. Install dependencies using `npm install`.\n3. Run `npm link` for creating symbolic link for global command access.\n4. Get an API key from the [CoinAPI](https://docs.coinapi.io/).\n5. Open cmd prompt or powershell to explore the available commands (`key`, `check`, etc.) and check cryptocurrency prices (see attached screenshot).\n\nFeel free to explore and customize it according to your requirements!\n\n### Credit\n\n- Brad Traversy (amazing man)\n- CoinAPI (for providing API key for development purpose)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkumaarbalbir%2Fcrypto-coindex","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkumaarbalbir%2Fcrypto-coindex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkumaarbalbir%2Fcrypto-coindex/lists"}