DebyGrey / metric-app

Metric App is a mobile web application to check a list of metrics (numeric values of stock data).Built with React-Redux

Metric App

📗 Table of Contents

• 📗 Table of Contents
• 📖 METRIC APP
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 METRIC APP

Metric App is a mobile web application to check a list of metrics (numeric values of stock data).

🛠 Built With

Tech Stack

React.js & Redux

Key Features

• displays a list of categories that could be filtered out by some parameter
• Retrieves data from the API to show detailed data in category

(back to top)

🚀 Live Demo

• Live Project Link(render)
• Project Demo Link

(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 have a prior knowledge of Linters, Git, HTML & CSS
• Clone or fork the repository
• A web browser (google chrome preferably)
• A code editor (e.g vscode)

Setup

Clone this repository to your desired folder:

cd my-folder git clone https://github.com/DebyGrey/metric-app

Install

To install this project run the following commands in your terminal:

• git clone https://github.com/DebyGrey/metric-app
• npm run install

Usage

To use this project run the following command:

• npm run start

Run tests

To run a test on this project run the following command:

• npm run test

Deployment

You can deploy this project:

• on any hosting services

(back to top)

👥 Authors

👤 Deborah Fashoro

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Modern website styles
• Full blown website with proper navigation

(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, kindly follow me on my social media handles listed above.

(back to top)

🙏 Acknowledgments

I would like to thank everyone who made this project possible Original Design Idea by Nelson Sakwa on Behance.

(back to top)

📝 License

This project is MIT licensed.

(back to top)