Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/bohaz/air-quality-monitoring-app

Air Quality Monitoring App is an intuitive single Page Application (SPA) displaying real-time air pollution levels across Venezuelan states.
https://github.com/bohaz/air-quality-monitoring-app

css jest reactjs redux-toolkit

Last synced: 29 days ago
JSON representation

Air Quality Monitoring App is an intuitive single Page Application (SPA) displaying real-time air pollution levels across Venezuelan states.

Awesome Lists containing this project

README

        

🌍 Air Quality Monitoring App

# πŸ“— Table of Contents

- [πŸ“– About the Project](#about-project)
- [πŸ›  Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [πŸš€ Live Demo](#live-demo)
- [πŸ’» 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)

# πŸ“– Air Quality Monitoring App

**Air Quality Monitoring App** is an intuitive single Page Application (SPA) displaying real-time air pollution levels across Venezuelan states.

![Airapp](https://github.com/bohaz/air-quality-monitoring-app/assets/127757182/6aa8d19c-fe9f-4264-aed7-ff996665130a)

## πŸ›  Built With

- React APP
- Redux
- Open Weather API

### Tech Stack

Client

### Key Features

- **Real-time Data**
- **User-Friendly Interface**
- **Comprehensive Details**
- **Visual Indicators**
- **Best organization**
- **Professional documentation**
- **Clean coding**

(back to top)

## πŸš€ Live Demo

[Click here](https://air-quality-monitoring-app.onrender.com) to see the project's deployment.

[Click here](https://www.loom.com/share/52864436930a45d3933d0d4bca1b9a77?sid=45639b2d-7999-4c37-a8b3-5100d0796e6c) to see my video presentation.

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

- Visual Studio Code installed
- Npm installed
- A GitHub account
- Git installed

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone [email protected]:bohaz/air-quality-monitoring-app.git
```

### Install

Install this project with:

-Install Node Modules

```sh
npm install
```

### Usage

To run this project, execute the following command:

-Start the development server

```sh
npm start
```

### Run tests

To run tests, run the following commands:

- ESLint linter errors run:

``` npx eslint "**/*.{js,jsx}" ```

-CSS linter errors run:

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

### Deployment

You can deploy this project using:

- Github

(back to top)

## πŸ‘₯ Authors

πŸ‘€ **Ricardo MartΓ­nez**

- GitHub: [@bohaz](https://github.com/bohaz)
- LinkedIn: [LinkedIn](www.linkedin.com/in/ricardomartínez∴)
- Portfolio: [Ricardo's Portfolio](https://ricardosportfolio.vercel.app/)

(back to top)

## πŸ”­ Future Features

- [ ] **[Functionality]**
- [ ] **[Content]**
- [ ] **[Descktop version]**
- [ ] **[Fetching more data]**

(back to top)

## 🀝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/bohaz/air-quality-monitoring-app/issues).

(back to top)

## ⭐️ Show your support

If you like this project let me know with a STAR!

(back to top)

## πŸ™ Acknowledgments

We would like to thaks Microverse for giving us the oportunity to build and contribute in projects like this.

Original design idea by Nelson Sakwa on Behance.

(back to top)

## πŸ“ License

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

(back to top)