/React_Graph

A real time stock tracker leveraging the Financial Modeling Prep API

Primary LanguageJavaScriptThe UnlicenseUnlicense

React_Graph


Logo

Stocker

Stonks go up 🚀🚀🚀
DD »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

Stocker

Built With

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

  • npm 
    npm i npm@latest -g

Installation

  1. Clone the repo 
    git clone https://github.com/jazznerd206/React_Graph.git
  2. Navigate to react app directory 
    cd graph
  3. Install NPM packages 
    npm i

Usage

As of the latest update, Stocker is a real time stock tracking application. Using the symbol search field, users can search valid stock symbols to return data about the company including basic biographical information, current news, financial health markers, current price and volume and analyst ratings.

FEATURE ONE: THE SEARCH TRIE Full Trie

  • Using a custom made m-ary prefix tree (Trie), the search field will return results in a dropdown for all symbols starting with the prefix value. IE typing 'M' into the symbol field will populate a dropdown with all symbols available starting with 'M'. Currently a naive implementation using a pre-made array of symbols, will update to CSV when available.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the Unlicense. See LICENSE for more information.

Contact

-> add persons of contact here Project Link: https://github.com/jazznerd206/React_Graph

Acknowledgements