anthonymr/stock-screener

A mobile web application to live checking stock prices consuming the Financial Modeling Prep API. Created with JavaScript, React, and Redux.

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Author
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Stock Screener

Stock Screener is a tool quickly find current stock prices in USA companies...

🛠 Built With

Tech Stack

Build With

• HTML
• CSS
• JavaScript
• React.js
• Redux toolkit
• Financial Modeling Prep API

Key Features

• Filter companies by economical sectors
• Display all companies by economical sectors and then filter by name or symbol

(back to top)

🚀 Live Demo

• Live Demo

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need: a properly working pc or laptop and a modern web browser.

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:anthonymr/react-capstone-project.git

Install

Install this project with:

  cd my-folder
  git clone git@github.com:anthonymr/react-capstone-project.git
  npm install

Usage

Use this app by runing:

  cd my-folder
  git clone git@github.com:anthonymr/react-capstone-project.git
  npm install
  npm start

Run tests

Test this app by runing:

  cd my-folder
  git clone git@github.com:anthonymr/react-capstone-project.git
  npm install
  npm test

Deployment

You can deploy this project using: GitHub but if you want to deploy make sure you let me know first :3

(back to top)

👥 Author

👤 Anthony Martin

• GitHub: Anthony Martin
• LinkedIn: Anthony Martin
• Twitter: Anthony Martin

(back to top)

🔭 Future Features

• Display all companies
• Add linear graph with company historic data

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, please, share it with your friends.

(back to top)

🙏 Acknowledgments

Especial thanks to Nelson Nelson Sakwa on Behance for the original design idea.

Thanks to Financial Modeling Prep for provide the API used in this project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)