Skip to content

This mobile web application allows users to list the Stocks, ETFs, and Funds traded in AMEX, NYSE, and Nasdaq Stock Exchanges and filter their search.

License

Notifications You must be signed in to change notification settings

enionsouza/stocks-watcher

Repository files navigation

Microverse GitHub last commit (branch) GitHub Repo stars

Stocks Watcher

About

This mobile web application was developed as the Capstone Project for Microverse React-Redux Curriculum Module. It was built upon Financial Modeling Prep API and the original design idea was created by Nelson Sakwa on Behance. My task was to check a list of metrics (data stock, in my case) making use of React and Redux. The application allows users to list the Stocks, ETFs, and Funds traded in AMEX, NYSE, and Nasdaq Stock Exchanges and filter their search.

Below, I present some screenshots of the app.

Home page Details page About modal

Built With

  • HTML, CSS, JavaScript;
  • ReactJS, Redux;
  • Bootstrap, React Stockcharts;
  • VisualStudio Code, Git, & GitHub;

Pre-requisites

  • NodeJs (v. 14.17)
  • YarnJs (v. 1.22.10)
  • Git

Live Demo

Live demo for this project can be found in this link.

Getting Started

To run this app running locally,you'll need an API key that you can easily obtain by registering at https://financialmodelingprep.com/register. You only need a valid email account to register freely. Now, go to the API dashboard and get your newly created API key! Store this token with you, because you'll need it for the next steps:

  1. In your terminal, in the folder of your preference, type the following bash command to clone this repository:
git clone git@github.com:enionsouza/stocks-watcher.git
  1. Now that you have already cloned the repo run the following commands to get the project up and running:
cd stocks-watcher
yarn
  1. For the last step of the process, you just need to edit the file APIKEY.js in the folder src/utils/. Make sure to change the APIKEY variable to the one that you got previously from the API dashboard. Now, on your terminal, run:
yarn start

This should start your local server in http://localhost:3000/. To stop it, hit <CTRL> + C on your keyboard.

Run tests

To test the App's components and logic, please, run the following command:

yarn test --watchAll

Make sure you have properly provided an API key, as explained in the steps above. When the tests are finished, just hit q key to leave the watch mode for the tests.

Author

👤 Ênio Neves de Souza

🤝 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!

📝 License

This project is MIT licensed.

About

This mobile web application allows users to list the Stocks, ETFs, and Funds traded in AMEX, NYSE, and Nasdaq Stock Exchanges and filter their search.

Topics

Resources

License

Stars

Watchers

Forks