📖 Stock Market Explorer

Stock Market Explorer This is a simple and intuitive online application that allows you to check the latest stock market trends and view detailed information about your favorite stocks. With Stock Market Explorer, you can easily filter stocks by revenue, see the latest prices and trends, and stay up-to-date with the latest financial news..

---

🛠 Built With

Tech Stack

• React
• Redux
• CSS/SCSS
• Javascript
• Jest

Key Features

• Display a list of several stocks to explore in
• Allows you to filter the stocks depending on their revenue
• Display of all stock in details where you can keep an eye to

(back to top)

🚀 Live Demo

• Open live demo

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need to install these prerequisites:

• If you're running on Windows you can download the prerequisites from the links down below:

Nodejs

Git

• If you're running on Linux follow these steps down below:

• Install git.

 sudo apt install git

• Install nodejs and npm.

 sudo apt install nodejs

Setup

Clone this repository to your desired folder:

  git clone git@github.com:Cluab/stock-market.git
  cd stock-market

Install

Install this project with:

  npm install

Usage

To run the project, follow below instructions:

• To run preview, execute the following command

npm run start

• To get a production build, execute the following command

npm run build

Run tests

To run tests, run the following command:

  npm run test

Deployment

You can deploy the production build of this project using npm library called gh-pages:

• First install the library

npm install gh-pages --save-dev

• Then follow the instructions provided in their readme file to deploy the app

GH Pages README

• deploy the build folder after running npm run build.

(back to top)

👥 Authors

👤 Ibrahim Suhail Alyousefi

• GitHub: Ibrahim Suhail Alyousefi

(back to top)

🔭 Future Features

• Improve user interface
• Add images to different stocks
• Add desktop version of the application

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

• I would like to thank Microverse for project inspiration.
• Original design idea by Nelson Sakwa on Behance.

(back to top)

❓ FAQ

• What version of nodejs does this project works on?

  • The project runs well with nodejs 14+. you might face some issues while running this project in lower versions.

(back to top)

📝 License

This project is MIT licensed.

(back to top)