Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/andrewjbateman/nodejs-api-data

:clipboard: Node.js app to display data from a cryptocurrency API. Tutorial code updated to latest ES6
https://github.com/andrewjbateman/nodejs-api-data

axios-rest colors commander configstore crypto cryptocoins cryptocurrency inquirer javascript json-api nodejs terminal

Last synced: 7 days ago
JSON representation

:clipboard: Node.js app to display data from a cryptocurrency API. Tutorial code updated to latest ES6

Host: GitHub
URL: https://github.com/andrewjbateman/nodejs-api-data
Owner: AndrewJBateman
Created: 2020-04-07T08:19:03.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2022-03-04T10:49:11.000Z (over 2 years ago)
Last Synced: 2023-03-02T09:37:25.104Z (over 1 year ago)
Topics: axios-rest, colors, commander, configstore, crypto, cryptocoins, cryptocurrency, inquirer, javascript, json-api, nodejs, terminal
Language: JavaScript
Homepage:
Size: 484 KB
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # :zap: Node.js API Data

* [Node.js](https://nodejs.org/en/) Command Line Interface (CLI) app that takes an API key user input and outputs [nomics cryptocurrency API](https://nomics.com/) data. Tutorial code (see 'Inspiration' below) updated to use ES6 module imports etc.

* **Note:** to open web links in a new window use: _ctrl+click on link_

![GitHub repo size](https://img.shields.io/github/repo-size/AndrewJBateman/nodejs-api-data?style=plastic)

![GitHub pull requests](https://img.shields.io/github/issues-pr/AndrewJBateman/nodejs-api-data?style=plastic)

![GitHub Repo stars](https://img.shields.io/github/stars/AndrewJBateman/nodejs-api-data?style=plastic)

![GitHub last commit](https://img.shields.io/github/last-commit/AndrewJBateman/nodejs-api-data?style=plastic)

## :page_facing_up: Table of contents

* [:zap: Node.js API Data](#zap-nodejs-api-data)

  * [:page_facing_up: Table of contents](#page_facing_up-table-of-contents)

  * [:books: General info](#books-general-info)

  * [:camera: Screenshots](#camera-screenshots)

  * [:signal_strength: Technologies](#signal_strength-technologies)

  * [:floppy_disk: Setup](#floppy_disk-setup)

  * [:computer: Code Examples](#computer-code-examples)

  * [:cool: Features](#cool-features)

  * [:clipboard: Status & To-Do List](#clipboard-status--to-do-list)

  * [:clap: Inspiration](#clap-inspiration)

  * [:file_folder: License](#file_folder-license)

  * [:envelope: Contact](#envelope-contact)

## :books: General info

* [Postman](https://www.postman.com) used to test API using a simple GET request

* [node.js bin](https://docs.npmjs.com/files/package.json) field used as executable file - maps command name to local file name. Important: file referenced in bin; `./bin/coindex.js` starts with `#!/usr/bin/env node`, otherwise the scripts are started without the node executable!

* `coindex.js` is the first file executed. This calls the files in the `commands` folder. The `key.js` file calls the `lib` class `KeyManager` which includes key set, view and delete functions. It also calls the `utils` const `isRequired`. The `check.js` file calls the `lib` classes `KeyManager` and `CryptoAPI` and uses axios to make a http call to the nomics cryptocurrency API.

## :camera: Screenshots

![postman screenshot](./img/postman.png)

![nodejs screenshot](./img/crypto.png)

## :signal_strength: Technologies

* [Node.js v16](https://nodejs.org/es/)

* [commander v9](https://www.npmjs.com/package/commander) node.js CLI solution

* [Inquirer v8](https://www.npmjs.com/package/inquirer) CLI user interface, used to prompt user for API key in `key.js` file

* [configstore v6](https://www.npmjs.com/package/configstore) used in KeyManager class to load and persist the API key user input

* [colors v1](https://www.npmjs.com/package/colors) to add colours to node.js (text colors: black, red, green, yellow, blue, magenta, cyan, white, grey. Other options available including bright colors etc.)

* [nomics cryptocurrency API](https://p.nomics.com/cryptocurrency-bitcoin-api) for JSON crypto coin data

* [axios v0.26.0](https://www.npmjs.com/package/axios) promise-based http client. `async/await` used instead of `.then()`

* [Postman API v8](https://www.postman.com/downloads/) to GET JSON data from API

## :floppy_disk: Setup

* Install dependencies using `npm i`

* Create `.env` file

* See `.env.example` then add a default 32-character key from [nomics cryptocurrency API](https://nomics.com/)

* Type `npm link` to make all commands work from any CLI directory

* Get yourself a 32-character key from [nomics cryptocurrency API](https://nomics.com/)

* type `nodejs-api-data` to get top level commands list; `key` to manage API key, `check` to see crypto currency prices and `help`

* type `nodejs-api-data key` to get API key commands list; `set` to add 32-character key, `show` to see API key and `remove` to delete the key

* type `nodejs-api-data key -h` to get full list of key help commands

* type `nodejs-api-data key set`to get add key prompt. Enter the key obtained from [nomics cryptocurrency API](https://nomics.com/)

* type `nodejs-api-data key show`to display the API key

* type `nodejs-api-data key delete`to delete the API key

* type `nodejs-api-data check price`to see list of crypto currency prices.

* type `nodejs-api-data check price --coin=BTC` to see price and rank of BTC crypto (comma separated coin names (with NO spaces) used by API GET request - note: putting a coin name of ' ' (empty space) will return a list of ALL 2709 cryto coins!)

## :computer: Code Examples

* `key.js` function to set API key from user input. Note: I replaced the isRequired utility to use my own key from the .env file as default if no other key is set. I also added a check of the input string to ensure it is 12 characters long and only contains letters or numbers. Keys are now 32 characters long.

```javascript

async set() {

  const keyManager = new KeyManager();

  const input = await inquirer.prompt([

    {

      type: "input",

      name: "key",

      message: "Enter API key obtained from https://nomics.com or press ENTER to use default API key. ".green

    },

  ]);

  // If user enters an empty string my default API key from the .env file is used

  if (input.key === "") {

    const key = keyManager.setKey(process.env.API_key);

    console.log("default API key used".blue);

    return key;

  }

  // check if user inputs a key that is alphanumeric & 32 characters long

  else if (input.key.length === 32 && input.key.match(alphaNumeric)) {

    const key = keyManager.setKey(input.key);

    console.log("API key set".blue);

    return key;

  }

  // user to input key again if the input key was not an empty string or it was not 32 characters long

  console.log("API key should be alphanumeric and 32 characters long. ".red + "Try again.".blue);

  return;

},

```

## :cool: Features

* `npm link` command used to make all commands work from any CLI directory

## :clipboard: Status & To-Do List

* Status: Working

* To-Do: Nothing

## :clap: Inspiration

* [Youtube: Traversy Media: httpsNode.js CLI For Cryptocurrency Prices](https://www.youtube.com/watch?v=-6OAHsde15E)

* [nomics Crypto API documentation](http://docs.nomics.com/#operation/getCurrenciesTicker)

## :file_folder: License

* N/A.

## :envelope: Contact

* Repo created by [ABateman](https://github.com/AndrewJBateman), email: [email protected]