Stock Market Recommender

Description

A frontend for a web application that can provides recommendations to a user to buy, sell or hold shares of a stock option. The algorithm used to generate the recommendations uses a correlation between social media posts and the stock price. The frontend is a clean and simple to use dashboard that can display all the information to the user to make the right decision.

Getting Started

Clone the current repository
Set your path to ./stockMarket/Frontend/
Run

npm install

Once it's install run

npm run start

You should be able to see the application in a browser at
http://localhost:8080/

To trigger the first analysis you need to enter a stock symbol in the designed input. Right now, only a few couple of stock symbol are valid. In an ideal world, the validation would be made by the backend.

Valid stock symbols : kirk, trill, tsla, logm, zm, vslr

Running the tests

You can run the test with

npm run test

Edit algorithm on the fly

If your browser's window is wide enough, you should see the 'Update Algorithm' button in the header. Once you've clicked on it, you will be able to enter a new algorithm to compute the recommendations and save it for the current session. If the browser is refreshed, the custom algorithm will need to be added back.

Here's an example of a custom algorithm that would only return the BUY recommendation.

(price, socialMediaCount) => {return recommendations.BUY;}

The valid return types are

recommendations.BUY
recommendations.HOLD
recommendations.SELL

Social Media Section

Once a list of recommendations is generated, you will see the social media section on the right. If you put your mouse long enough on the graph, you will be able to see more details about the social media posts.

Todo

I should add more security to the Edit algorithm section.