Stock Tracker React Site

Welcome to the Stock Tracker React Site repository! This project is a simple web application built with React.js that allows users to track and monitor stock prices. It provides a user-friendly interface to view real-time stock data, add stocks to a watchlist, and stay informed about market trends.

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
• Usage
• Features
• Contributing

Getting Started

Prerequisites

Make sure you have the following software installed on your machine:

• Node.js
• npm (Node Package Manager)

Installation

To get started with the Stock Tracker React Site, follow these steps:

1. Clone the repository:

   git clone https://github.com/BeeTillman/Stock-Tracker-React-Site.git

2. Change into the project directory:

   cd Stock-Tracker-React-Site

3. Install dependencies:

   npm install

These commands will clone the project from the GitHub repository, navigate you into the project directory, and install the necessary dependencies using npm.

Now you have successfully set up the Stock Tracker React Site on your local machine!

Usage

WIP (I am using this for a simple stock tracking monitor and will upload screenshots here)

Features

• Real-time Stock Data: Get up-to-date stock prices and information.
• Watchlist: For simplicity sake (and reduction of calls to API), users can choose from 5 stocks to track.
• User-Friendly Interface: A simple, 5 button interface makes it easy to navigate on RPi touch displays.

Contributing

If you'd like to contribute to this project, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them with descriptive commit messages.
4. Push your changes to your fork.
5. Submit a pull request.