/Metrics-webapp

Primary LanguageJavaScript

📗 Table of Contents

📖 [your_project_name]

[Stock Screeners] is a metric website containing data or parameters used for stock screening. It displays a list of companies from all over the world with the corresponding parameters and values. The user can filter the application by company's name. It is more beneficial to those who search for stocks. The data is extracted from the Financial Modeling Prep API.

🛠 Built With

Tech Stack

  • [React]
  • [Redux]
  • [CSS]
  • [Jest]

Key Features

  • [Display list of companies]
  • [Filter the list by company name]
  • [Display screeners details]

(back to top)

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

Node-js npm

Setup

Clone this repository to your desired folder:

git clone git@github.com:Bhekisile/Metrics-webapp/.git

Install

Install this project with:

npm install

Usage

To run the project, execute the following command:

npm start

Run tests

To run tests, run the following command:

npm test

Deployment

You can deploy this project using:

Render

(back to top)

👥 Authors

Mention all of the collaborators of this project.

👤 Bhekisile Jozi

(back to top)

🔭 Future Features

  • [User sign up]

(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 you can star the repository.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for giving me all the necessary knowledge I need to make this project.

Nelson Sakwa the author of the original design, as required by the Creative Commons License.

(back to top)

📝 License

This project is MIT licensed.

(back to top)