Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mozameljawad/metrics-webapp

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 comp
https://github.com/mozameljawad/metrics-webapp

css3 grid-layout html5 jest-tests reactjs redux-toolkit test-library-react testng

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/mozameljawad/metrics-webapp
Owner: MozamelJawad
License: mit
Created: 2023-09-11T06:56:33.000Z (over 1 year ago)
Default Branch: dev
Last Pushed: 2023-09-15T06:34:47.000Z (over 1 year ago)
Last Synced: 2024-05-17T15:26:22.960Z (8 months ago)
Topics: css3, grid-layout, html5, jest-tests, reactjs, redux-toolkit, test-library-react, testng
Language: JavaScript
Homepage: https://6503f9f3a24bc45efd2082ff--inspiring-sherbet-e7eaca.netlify.app/
Size: 431 KB
Stars: 4
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # 📖 Metrics Web App  





  


  




# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Live Demo](#live-demo)

    - [Key Features](#key-features)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#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](https://metric-webapp-1y1r.onrender.com)

- [Live Demo in Netlify](https://6503f9f3a24bc45efd2082ff--inspiring-sherbet-e7eaca.netlify.app/)

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

```sh

  cd your-prefered-folder-name

  

  git clone https://github.com/MozamelJawad/metrics-webapp.git

```

### Install

- Install this project with:

```sh

  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:

```sh

  npm start

```

### Run tests

To run tests, run the following command:

```sh

  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](https://github.com/MozamelJawad)

- Twitter: [@twitterhandle](https://twitter.com/mozameljawad)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/mozamel-jawad/)

(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](https://github.com/MozamelJawad/metrics-webapp/issues).

(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](https://www.behance.net/sakwadesignstudio) for the inspiring design.

(back to top)


## 📝 License 

This project is [MIT](./LICENSE) licensed.

(back to top)