Skip to content

afarahmand/commodity-analyzer

Repository files navigation

Commodity Analyzer

Live App

Background and Overview

Commodity Analyzer is a tool using chart.js to chart information related to commodities.

Users select one or more commodities and are shown historical information about their selection. Since a commodity has multiple values throughout a day, I anticipate using only one or more of the close price, minimum, or maximum price.

Commodity Analyzer will use the Quandl API to access stock and commodity data.

Functionality & MVP

  • As a first feature, users are able to view a first chart of time-series information related to one or more selected commodities. Displayed information includes at least price information.

Wireframes

The app will include a single screen with the first and second charts together with an input text box and a submit button.

[https://raw.githubusercontent.com/afarahmand/stock-alerter/master/stock_alerter.png] (Commodity Analyzer)

Architecture and Technologies

The following technologies will be used for this project:
  • Vanilla Javascript
  • chart.js for charting information
  • Quandl API for accessing stock and commodity data
  • Webpack for bundling

It is anticipated that there will be 4 scripts in addition to the webpack entry file:

  • chart.js - the standard chart.js library for charting
  • stock_api_util.js - a script for constructing one or more requests to the Quandl API based on a user selected stock, commodity, or combination thereof
  • chart1.js - a script for creating a line chart based on the user selected input that displays either a chart of time vs. price or time vs. the result of the mathematical expression

Implementation Timeline

Weekend

* project proposal
  • implement a basic chart.js time-series chart from static data

Day 1

* Continue working on chart
  • Make the chart look good: zooming, have ticks, have it scale appropriately (especially when zooming)

Day 2

* Receive real data from Quandl API and display on chart1
  • Receive data based on user input of only 1 stock or commodity

Day 3

* Extend the functionality of chart1 to display based on a mathematical equation of 2 or more stocks or commodities

Day 4

* Be able to mouseover line chart of chart 1

Bonus features:

* Implement an alerter service that allows a user to set a condition, and if that condition is met, notify the user via email. The condition could initially include less than or greater than some value.
  • Add volume or additional stock indicators (RSI, etc.) to chart1

  • A statistical analysis will be performed on the data, and a second chart will show a probability mass function that plots the probability of a value vs. the value.

Releases

No releases published

Packages

No packages published

Languages