README.md

📖 Metrics Web App

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Live Demo
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Metrics Web App

Metrics Web App is an outstanding mobile web application listing all active companies in the financial market. This project has two pages. The first page is the application's main page, which lists all companies with a search bar. When someone clicks on the company, the user will be redirected to the second page, showing all the details of the company.

Built With

• HTML
• CSS
• JAVASCRIPT
• REACT
• Redux

Tech Stack

Markup Language

• HTML

Style

• CSS

Layout

• Flexbox

Interaction and Dynamic HTML

• Javascript

Module Bundler

• React

Testing

• Jest

🚀 Live Demo

• Live Demo
• Live Demo in Netlify

Key Features

• List All companies from API
• Show the details of each company
• Dynamic search bar

(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 the following tools:

• Node.js on your computer
• Code editor e.g.: VScode

Setup

Clone this repository to your desired folder by running the following commands in your terminal:

  cd your-prefered-folder-name
  
  git clone https://github.com/MozamelJawad/metrics-webapp.git

Install

• Install this project with:

  cd metrics-webapp

  npm install or npm i

• Run an optimized build for prodction:

  npm run build

Usage

To run the project, execute the following command:

  npm start

Run tests

To run tests, run the following command:

  npm run test

Deployment

You can deploy this project by transferring the files in your local repository onto your server

(back to top)

👥 Authors

👤 Mozamel Jawad

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

(back to top)

🔭 Future Features

• I will add more dynamic features

(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

• Thanks to the Microverse team for the great curriculum and opportunity.
• Thanks to Nelson Sakwa for the inspiring design.

(back to top)

📝 License

This project is MIT licensed.

(back to top)