📗 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

📖 [Stock Metrics Webapp]

Stock Metrics is a web(mobile-focused) software for monitoring the stock exchange's listed firms and seeing their live metrics. It uses data from the Financial Modeling API.

🛠 Built With

• HTML
• CSS
• JavaScript
• React
• Webpack
• chart js
• redux
• React Testing Library
• jest
• linter

Tech Stack

Client

• React.js

Server

• Express.js

Database

• PostgreSQL

Key Features

Describe between 1-3 key features of the application.

• created pages folder for the structure of the pages.
• Wrote tests
• Added a 404 error page
• Added a loader to help keep users waiting while data is being fetched
• Added dynamic routing the details page
• Implemented search bar functionality using reducers and redux store
• Implemented charts to present the dynamically generated net income and gross profit in a line chart and bar chart.

(back to top)

🚀 Live Demo

• Stock Metrices Live

(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:

• node.js
• git

Setup

Clone this repository to your desired folder:

• Open your terminal

• Navigate to the directory where you want to clone the project.

• Clone the project using by running the following command:

git clone https://github.com/osamaashraf6/Metrices-Webapp.git

Install

Install this project with: node js, run this command npm install in the terminal

Usage

To run the project, execute the following command:

• npm run build
• npm run start

Run tests

To run tests, run the following command:

• npm run test

Deployment

You can deploy this project using: npm run deploy

(back to top)

👥 Authors

Mention all of the collaborators of this project.

👤 Author1

• GitHub: Osama Ashraf
• Twitter: Osama Ashraf
• LinkedIn: Osama Ashraf

(back to top)

🔭 Future Features

Describe 1 - 3 features you will add to the project.

• I will enhance the code in the future and try to add some new things💯

(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 leave a star ⭐️

(back to top)

🙏 Acknowledgments

• I would like to thank Microverse for motivating me to build this beautiful project💯
• Original design idea by Nelson Sakwa on Behance.. Under the Creative Commons License👌

(back to top)

❓ FAQ

• [How to run this project?]

  • [You need to have Node.js in your local machine, and in the root of the project write npm run start in the terminal]

• [Is it open source?]

  • [Yes you are allowed to use this project]

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)