aburg15 / market-watch

Market Watch was created to provide users with a quick, intuitive and informative dashboard which displays up to date cryptocurrency stock information.

Market Watch

A UI for viewing cryptocurrency stock prices, market cap and daily % change.
View demo

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Market Watch was created to provide users with a quick, intuitive and informative dashboard which displays up to date cryptocurrency stock information. Users have the ability to click on each cryptocurrency listed in order to learn more information behind the currency that was selected.

This project uses React, Cypress, JavaScript, React Router and data pulled from a RESTful API to display a dashboard of stocks. Select a stock to learn more about it.

This project was crafted as part of the curriculum for Turing School of Software and Design. You can view the project spec here.

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

This project is deployed here on GitHub Pages, but if you'd like to interact with it on your local machine, follow the instructions below.

Installation

1. Clone the repo

   git clone https://github.com/aburg15/market-watch.git

2. Install NPM packages

   npm install

3. Deploy the project on your machine

   npm start

(back to top)

Usage

Scroll through the main page to view all stocks in the database. To find a specific stock, use the search bar in the header. Click on a stock to view its details.

Main Page

Specific Stock Page

Dark Mode

Error Handling

Responsive Design

(back to top)

Wins And Challenges

Wins

• The biggest win was building the app and completing the functionality using a non-Turing provided API. API's that have not been vetted may appear to be easier to work with than they really are.
• Successfully implementing Cypress, Router and React in a non-group project.
• Filtering the stock data that was fetched from an external API via the use of a search bar.

Challenges

• Using a non-Turing provided API endpoint proved to be challenging. A big lesson learned was to test all of the object properties from the API before starting the project.
• Having to build out a React component architecture for the first time in a non-group setting.

Future Updates

I was able to accomplish a lot with this project. However, there a few things I would like to improve on in future iterations:

• Fine-tune the responsive design
• More robust selected stock page content
• Improved accessibility experience
• Utilizing Sass to DRY up styling

Contributors

Adam Burgess GH

(back to top)