README.md

Stock Metrics App

The Metrics HUB is a web(mobile-focused) app for checking the companies listed on the stock exchange to see their live metrics. Its data is consumed from the Financial modelling API.

Live Demo

• Link to Live Version

Built With

• Major languages (HTML, CSS, JavaScript)

• Frameworks / Libraries

  - React (Front end library)
  - Redux (State Management)
  - Jest(unit testing)
  - React Testing Library

• Technologies used

  - Git(version control)
  - Git(version control)
  - ESLint(JavaScript linting)
  - Stylelint(style linting)

Getting Started

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

Prerequisites

• A text editor(preferably Visual Studio Code)

Install

• Git
• Node

Usage

Clone this repository

$ [email protected]:BenjaminSemah/the-metrics-hub.git
$ cd the-metrics-hub

Run project

$ npm install
$ npm build
$ npm run test
$ npm start

Open page in browser

$ runs on http://localhost:3001/

Author

👤 Benjamin Semah

• GitHub: Benjamin Semah
• Twitter: Benjamin Semah
• LinkedIn: Benjamin Semah

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Acknowledgement

Original design idea by Nelson Sakwa on Behance.. Under the Creative Commons License

Show your support

Give a ⭐️ if you like this project!

📝 License

This project is MIT licensed.