Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

This React project is about building a mobile web application to check a list of metrics (numeric values) created making use of React and Redux.
https://github.com/adeola003/metrics-webapp

Last synced: about 1 month ago
JSON representation

This React project is about building a mobile web application to check a list of metrics (numeric values) created making use of React and Redux.

Awesome Lists containing this project

README

        

Metrics Webapp

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)

- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)

# 📖 [Metrics_Webapp]

**[Metrics_Webapp]** This React project is about building a mobile web application to check a list of metrics (numeric values) created making use of React and Redux.

## 🛠 Built With

### Tech Stack

Client

### Key Features

- [x] Created a web app using react-redux
- [x] Added all necessary fetures for displaying Rockets and Missions.
- [x] Used React and Redux technology.
- [x] Used `axios` to fetch data from the API.
- [x] Used store, actions and reducers in React.
- [x] Used React hooks.

(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:
Open terminal on the same folder of the project and run:

```sh
npm install
```

### Setup

Clone this repository to your desired folder:

```sh
git https://github.com/adeola003/Metrics-webapp.git
cd metrics-webapp
```

### Install

Install this project with:

```sh
npm install
```

### Usage

```
1. download the project from clone
2. Install all dependencies using *npm install*
3. Run *npm start*
4. You can see it in the browser
```

### Build for production

```
npm run build
```

### Run tests

- ### Linter Tests

To run tests, run the following command:

To check for html errors run:

```sh
npx hint .
```

To check for css errors run:

```sh
npx stylelint "**/*.{css,scss}"
```

To check for js errors run:

```sh
npx eslint .
```

(back to top)

## 👥 Authors

👤 **Abdel-Khafid SALAOU**

- GitHub: [@githubhandle](https://github.com/adeola003)
- Twitter: [@twitterhandle](https://twitter.com/khadaf6)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/abdel-khafid-salaou/)

(back to top)

## 🔭 Future Features

- [x] Add the live demo for the project
- [x] Add new interesting features to the project

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issue page](https://github.com/adeola003/Metrics-webapp/issues).

(back to top)

## ⭐️ Show your support

If you like this feel free to follow me on github and give this project a star.

(back to top)

## 🙏 Acknowledgments

- Thanks to the Microverse team for the great curriculum.
- Thanks to the Code Reviewer(s) for the insightful feedbacks.
- Hat tip to anyone whose code was used.

(back to top)

(back to top)

## 📝 License

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

(back to top)