Technical task completed for Node.js position.

.env

@@ -0,0 +1 @@
+ALPHA_VANTAGE_API_URL=https://www.alphavantage.co/query

.gitignore

@@ -0,0 +1,3 @@
+.idea
+node_modules
+dist

.prettierignore

@@ -0,0 +1,2 @@
+.idea
+node_modules

.ttrc

@@ -0,0 +1,4 @@
+{
+  "apiKey": "",
+  "exchange": "BSE"
+}

Dockerfile

@@ -0,0 +1,20 @@
+# Use the official Node.js image as the base image
+FROM node:14-alpine
+
+# Create a new directory to hold our application code
+WORKDIR /app
+
+# Copy package.json and package-lock.json files into the container
+COPY package*.json ./
+
+# Install the dependencies
+RUN npm install
+
+# Copy the rest of the application code into the container
+COPY . .
+
+# Build the TypeScript code
+RUN npm run build
+
+# Set the entrypoint to run the CLI
+ENTRYPOINT ["node", "dist/index.js"]

README.md

@@ -1,181 +1,81 @@
-# Tilli Node.js Developer Challenge
+# Tilli Ticker
 
-Thank you for your interest in Tilli! The following coding challenge should take no longer than 2-3 hours. Please feel free to reach out for any clarification on the requirements presented below.
+```tt``` is a CLI application that fetches stock details from the Alpha Vantage API. It allows you to track stocks and view summary statistics for any stock symbol and exchange supported by the API.
 
-## Getting started
+## Installation
+Install the dependencies using ```cd node-developer-challenge && npm i```
 
-Fork this repository and use your fork to build the challenge. When you've finished and all of your work is pushed, let us know so that we can review (you can also submit a PR back to this repo to notify).
-
-## Terminology
-
-| Term               | Description               | AKA | Example(s) |
-| :----------------- | :------------------------ | --- | ------- |
-| Stock symbol       | A unique series of letters assigned to a stock for trading purposes (e.g. AAPL for Apple Inc.) | Stock ticker, Ticker symbol | AAPL (Apple Inc.) |
-| Exchange           | A market where financial securities such as stocks, bonds, and commodities are traded. | Stock exchange | NASDAQ, NYSE, NSE |
-
-## The challenge
-
-Your task is to create an interactive Node.js CLI application that will show summary statistics for requested stock ticker symbols using the [Alpha Vantage](https://www.alphavantage.co/documentation/) API. The interactive CLI app will require managing and persisting state, processing input arguments, and showing interactive prompts and follow up prompts depending on the inputs. The application should be able to handle the below requirements for any amount of stock symbols on any exchange supported via the Alpha Vantage API.
-
-### Features
-
-The output below is a stubbed version of the helper text (`-h` flag, though the actual output below is more representative of a `man` page) for the application. Flags in the `OPTIONS` section correspond with features. The interactive CLI app should be able to parse incoming arguments and generate interactive prompts to fill in missing information.
-
-Some sections are deliberately left incomplete (they will be marked via `[STUBBED]`); your final submission should also include updated documentation.
-
-Any implementation details that have not been included have been deliberately left out for you to create your own solution.
-
-```zsh
-> tt -h
-
-# output
-NAME
-  tt - tilli ticker
-
-SYNOPSIS
-  tt [-x exchange] [-a api-key] [-c config-file] [exchange:]ticker
-
-DESCRIPTION
-  tt  a CLI app that allows you to continuously track stocks using the AlphaVantage API. An AlphaVantage API key is needed to use this utility.
-
-OPTIONS
-  -x exchange
-      Specific stock exchange to use when doing the stock symbol lookup. This can be appended to the ticker argument directly by preceding the ticker argument with the exchange plus ":" (e.g. NASDAQ:AAPL) Throws if the exchange does not exist or if the stock symbol is not found on the exchange.
-
-  -a api-key
-      Use specified AlphaVantage API key. If no global config present or global config has no API key then interactive mode will launch to query the user for an API key.
-
-  -v  View the stock summary stats for the current day once found or chosen. Is inferred to be true if the -s flag is not present.
-
-  -s  Save the stock symbol and its summary statistics.
-
-  -l  View all saved stocks.
-
-  -d  Delete a saved stock symbol.
-
-  -h  View command usage.
-
-FILES
-  ~/.ttrc
-    The global configuration file.
-
-DIAGNOSTICS
-  The following diagnostics may be issued on stderr:
-
-  Rate limit exceeded.
-    The API key used in the configuration has gone past the rate limit set by the AlphaVantage API. Please either wait for a new rate period or upgrade your API key.
-  [STUBBED] - add additional potential diagnostics for errors here
-
-AUTHOR
-  [STUBBED] - make sure to sign your code!
+```sh
+npm run build
+npm link
 ```
 
-### Interactive mode
+This command will link our package to the global npm directory on the local machine, allowing us to use the ```tt``` command directly.
 
-The CLI app should launch interactive mode whenever additional input is needed from the user. Below is a diagram showing some of the code paths taken by interactive mode and how certain paths can be skipped via arguments being passed  in.
+## Usage
+To use ```tt```, run the following command:
 
-```mermaid
-flowchart TD
-  init[Invoke with `tt`]
-
-  apiKey[Input API Key]
-
-  exchange[Input stock exchange]
-
-  ticker[Input ticker]
-
-  listAll[[1.View specific stock\n2.Save specific stock\n3.View and save a specific stock\n4.List all saved stocks\n5.Delete a saved stock]]
-
-  view[View stock]
-
-  listStocks[List stocks]
-
-  save[Save stock]
-
-  delete[Delete stock]
-
-  init-- "tt" ---->apiKey-->ticker---->exchange---->listAll
-  linkStyle 0 stroke:#fff
-  linkStyle 1 stroke:#fff
-  linkStyle 2 stroke:#fff
-  linkStyle 3 stroke:#fff
-
-  init-- "tt ticker" --->apiKey-->exchange-->listAll
-  linkStyle 4 stroke:#ff3
-  linkStyle 5 stroke:#ff3
-  linkStyle 6 stroke:#ff3
-
-  init-- "tt -x [exchange]" -->apiKey-->ticker-->listAll
-  linkStyle 7 stroke:#f3f
-  linkStyle 8 stroke:#f3f
-  linkStyle 9 stroke:#f3f
-
-  init-- "tt -a [api-key]" -->ticker-->exchange-->listAll
-  linkStyle 10 stroke:#3ff
-  linkStyle 11 stroke:#3ff
-  linkStyle 12 stroke:#3ff
-
-  init-- "tt -a [api-key] ticker" --------->exchange-->listAll
-  linkStyle 13 stroke:#f33
-  linkStyle 14 stroke:#f33
-
-  init-- "tt -x [exchange] ticker" -->apiKey-->listAll
-  linkStyle 15 stroke:#33f
-  linkStyle 16 stroke:#33f
+```
+tt [options] exchange:ticker
+```
 
-  init-- "tt -x [exchange] -a [api-key] ticker" -->listAll
-  linkStyle 17 stroke:#999
+The [options] argument is optional and specifies how you want to interact with tt CLI. The ```exchange:ticker``` specifies the exchange and stock symbol . If you do not specify an exchange, CLI will enter the interactive mode.
 
-  init-- "tt -x [exchange] \ \n-a [api-key] -s ticker" -->save
-  linkStyle 18 stroke: #f9f
+# Options
+- -x, --exchange: Specifies the stock exchange to use when looking up the stock symbol. You can append the exchange directly to the ticker argument by preceding it with the exchange plus ":" (e.g. NASDAQ:AAPL). This option throws an error if the exchange does not exist or if the stock symbol is not found on the exchange.
+- -a, --apiKey: Specifies the AlphaVantage API key to use. If there is no global config present or the global config has no API key, tt will launch interactive mode to query the user for an API key.
+- -v, --view: Displays the stock summary statistics for the current day once found or chosen. This option is inferred to be true if the -s flag is not present.
+- -s, --save: Saves the stock symbol and its summary statistics.
+- -l, --list: Displays all saved stocks.
+- -d, --delete: Deletes a saved stock symbol.
+- -c, --configFile: Specifies the configuration file to use.
+- -h, --help: Displays the help for the command.
 
-  init-- "tt -x [exchange] \ \n-a [api-key] -s -v ticker"-->save-->view
-  linkStyle 19 stroke:#f99
-  linkStyle 20 stroke:#f99
+# Config FILES
+  `tt -c .ttrc`
+  The global configuration file.
 
-  init-- "tt -x [exchange] \ \n-a [api-key] -v ticker" -->view
-  linkStyle 21 stroke:#99f
+# Diagnostics
+The following diagnostics may be issued on stderr:
 
-  init-- "tt -x [exchange] \ \n-a [api-key] -l ticker" -->listStocks
-  linkStyle 22 stroke:#9f9
+- Rate limit exceeded.: The API key used in the configuration has gone past the rate limit set by the AlphaVantage API. Please wait for a new rate period or upgrade your API key.
+- Invalid API key.: The provided API key is invalid or has been revoked. Please check your API key and try again.
+- Stock symbol not found.: The specified stock symbol could not be found. Please verify the stock symbol and try again.
+- Stock exchange not supported.: The specified stock exchange is not supported by the AlphaVantage API. Please check the exchange abbreviation and try again.
+- Configuration file error.: An error occurred while reading or parsing the configuration file. Please verify the contents of the configuration file and try again.
 
-  init-- "tt -x [exchange] \ \n-a [api-key] -d ticker" -->delete
-  linkStyle 23 stroke:#6f6
+# Examples
 
-  listAll-- "3" -->save-->view
-  linkStyle 24 stroke:#f22
-  linkStyle 25 stroke:#f22
+View Help
 
-  listAll-- "1" -->view
-  listAll-- "2" -->save
-  listAll-- "4" -->listStocks
-  listAll-- "5" -->delete
+```sh
+tt --help
 ```
 
-## Evaluation criteria
-
-- UX of the interactive mode of the CLI
-- Argument processing
-- Caching strategies
-- State management
-- Error management
-- Code hygiene
-- Documentation
-- Secrets management
-- Clean git history
+![img.png](docs/imgs/img.png)
 
-## Extra credit
-
-> Doing any of the below will help your application (if *done well*) but your strength as a candidate is only measured using the tangibles above.
+Enter Interactive Mode
+```
+tt
+```
+![img.png](docs/imgs/img_0.png)
 
-- use TypeScript
-- add unit tests
-- create a build process for distribution
+View and save the ticker.
+```
+ tt -s -v IDEA
+```
 
-## Some additional notes
+![img.png](docs/imgs/img_1.png)
 
-Certain implementation details have been **deliberately** left out in order to gauge your ability to fill in the gaps. Don't be afraid to ask questions, but also don't be surprised if for certain questions the response is that it's up to you to determine that.
+Following Exchange & Tickers can be used to test the application Quickly.
 
-There are no reservations about libraries that you use, and it is definitely recommended that you use one (or multiple) of the many CLI tooling packages in the js ecosystem in order to focus on building the functionality rather than the barebones CLI portion of this application.
+- exchange ``BSE``
 
-Make sure to review all of the evaluation criteria! These are the exact points you will be judged on.
+- Tickers
+``
+RELIANCE
+TATAPOWER
+IRCTC
+IDEA
+ZEELEARN
+``