belsman / React-Capstone

This is a frontend web application, developed using React and Redux which lists a catalog of financial values using Stock API.

Project: React-Capstone

Catalogue of Statistics

This is a frontend web application, developed using React and Redux which lists a catalogue of financial values using Stock API.

The application features

• Display the Most Active Stocks
• Display the Most Gaining Stocks
• Display the Most Losing Stocks
• Open individual stock item and shows further details
• Search for a particular stock item or Stock items, example 'AAPL'

Live version

🔗 Click here to go live

Built With

• React
• Redux
• Bootstrap 4
• Font awesome 5

Run Stockr Locally

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

Prerequisites

In order to run Stockr locally, you will require the following:

• Nodejs and npm
• An API key for consuming the Financial Modelling Prep API data
• You are ready to go!

Install

1. Open the Terminal
2. Run

git clone https://github.com/belsman/React-Capstone.git

or, for SSH:

git clone [e-mail]:belsman/React-Capstone.git

3. Run cd React-Capstone to enter the main directory
4. Run npm install
5. Configure the API KEY
   • Sign up to get an API
   • Navigate to the dashboard to copy the API
   • Create .env file in the current directory, open it and add REACT_APP_API_KEY=YOUR_API_KEY_HERE
6. Run npm start to launch Stockr
7. Happy viewing!

Testing

1. Open the Terminal
2. Run cd React-Capstone to enter the root directory of the project
3. Run npm test

Author

👤 Bello Babakolo

• Github: @belsman
• Twitter: @d_belsman
• Linkdin: Bello Babakolo

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

• Microverse Inc
• Financial Modelling Prep API