eversardoth / macheightexercise

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage

About The Project

The project is to write a function that searches through NBA player heights based on user input. The raw data is taken from here. The data is served in json format by the endpoint here.

The task is to create an application that takes a single integer input. The application will download the raw data from the website above (https://mach-eight.uc.r.appspot.com) and print a list of all pairs of players whose height in inches adds up to the integer input to the application. If no matches are found, the application will print "No matches found".

(back to top)

Built With

• Javascript
• Jest

(back to top)

Getting Started

Prerequisites

In order to install and use the application you need to have installed in your system a supported version of:

• Node.js

Installation

1. Clone the repo

   git clone https://github.com/eversardoth/MachEightExercise.git

2. Inside the repo install NPM packages

   npm install

(back to top)

Usage

In order to use the application you need to run the following command inside the repo

node app **IntegerInput**

The application will take the integer input, download the raw data from the website, and print a list of all pairs of players whose height in inches adds up to the integer entered. If no matches are found, the application will print "No matches found".

Additionally, to trigger all unit testing suites you need to run the following command inside the repo

npm test

This will trigger the execution of all unit tests for the proyect, printing in the console a summary of the results, but also generating a coverage folder where more information about the unit testing results can be found.

(back to top)