jmonto55/Sotck-Viewer

This web application was developed using React and Redux. It enables users to access and analyze stock-related data, including stock prices and information. React, provides a responsive and interactive user interface, while Redux ensures efficient state management for seamless data fetching and manipulation.

Quantum Stocks

📗 Table of Contents

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

📖 Quantum Stocks

Quantum Stocks is a web application where you can visualize detailed information about any stock traded in the six biggest markets.

🛠 Built With

Tech Stack

Client

• React to create the UI.
• Redux Toolkit to manage state.
• Tailwindcss to apply awesome styles.

Server

• Financial Modeling Prep API

Database

• N/A

Key Features

• Users can filter stocks for specific market.
• Users can filter stocks using name or symbol.
• Users can see detailed information about any stock.
• The application is fully responsive.

(back to top)

🚀 Live Demo

• Live Demo

(back to top)

💻 Getting Started

To get a local copy of this project and run it in your computer, follow these steps.

Prerequisites

In order to run this project you need:

• A working computer.
• Connection to internet.
• npm and Node.js installed, if you don't have them, please follow this simple installation guide.

Setup

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

Clone this repository in the desired folder:

cd my-folder
git clone https://github.com/jmonto55/Stock-Viewer.git

Install

To install this project:

cd Stock-Viewer
code .
npm install

Usage

To run the project, execute the following command:

npm start

Run Tests

To run the project tests, execute the following command:

npm test

(back to top)

👥 Authors

👤 Jose Montoya

• GitHub: @jmonto55

(back to top)

🔭 Future Features

• Corrections spotted by reviewer will be implemented

(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 feel free to frok it and use it as you need.

(back to top)

🙏 Acknowledgments

I would like to thank Nelson Sakwa for the design

• Behance: @sakwadesignstudio

(back to top)

❓ FAQ (OPTIONAL)

• Can I use the project for any purpose?

  • Yes, you can use this files for anything you need.

• Is the information saved in any database?

  • No, all data is fetched from API.

(back to top)

📝 License

This project is MIT licensed.

(back to top)