Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/besufekad-haz/react-capstone-air-pollution

Air Pollution web app provides a simple interface for quickly displaying Air pollution data for different countries. In Addition, it provides current, forecast and historical air pollution data for any coordinates on the globe.
https://github.com/besufekad-haz/react-capstone-air-pollution

Last synced: 16 days ago
JSON representation

Host: GitHub
URL: https://github.com/besufekad-haz/react-capstone-air-pollution
Owner: Besufekad-HAZ
License: mit
Created: 2023-04-24T12:10:32.000Z (over 1 year ago)
Default Branch: development
Last Pushed: 2024-09-26T13:56:22.000Z (4 months ago)
Last Synced: 2024-12-15T01:30:05.566Z (30 days ago)
Language: JavaScript
Size: 628 KB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        



   

    


  

  Air Pollution Data Web App

  



# 📗 Table of Contents

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

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

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [Screenshot](#screenshot)

  - [Loom Presentation Video](#loom-video)

  - [🚀 Live Demo](#live-demo)

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

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [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)

# 📖 Air-Pollution-Data 

["Air-Pollution-Data"] :- "Air-Pollution-Data" is a React Capstone Project that provides a simple interface for quickly displaying Air pollution data for different countries. In Addition, it provides current, forecast and historical air pollution data for any coordinates on the globe.

## 🛠 Built With HTML,CSS and React and Redux

### Tech Stack 

  Client

  


    HTML

    CSS

    JavaScript

    Webpack

    React website

    Redux Toolkit website


  


  Server

  


    N/A

  


Database

  


    N/A

  


### Key Features 

- **[HTML]**

- **[CSS]**

- **[Javascript]** ---> with ES6

- **[Webpack]**

- **[React]**

- **[Redux]**

- **[Redux_Toolkit]**

(back to top)


## 🚀 Screenshot 

![image](https://user-images.githubusercontent.com/23375153/234661822-5c4274ec-5499-4fe1-a4d7-959d35075453.png)

## 💻 Loom Presentation Video 

- [Loom Presentation Video Link](https://www.loom.com/share/8c466a2029f041369e611916bc4ac33c)

## 🚀 Live Demo 

- [Live App Link](https://644953ccb52d2a23ea2ab507--air-pollution-stats.netlify.app/)

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

- A Computer (MAC or PC)

- Code editor (VSCode,Atom etc...)

- A browser (Chrome,Mozilla,Safari etc...)

- Version Control System (Git and Github)

- NodeJS (https://nodejs.org/en/)

- React {https://react.dev/}

### Setup

Clone this repository to your desired folder:

```

cd my-folder

git clone [email protected]:Besufekad-HAZ/React-Capstone-Air-Pollution.git (SSH)

```

### Install

Install this project with:

- `npm init`

- `cd React-Capstone-Air-Pollution`

- `npm install --save-dev [email protected] [email protected] [email protected] [email protected]`

- `npm install --save-dev [email protected] [email protected] [email protected] [email protected]`

- `npm start`

### Run tests

To run tests, run the following command:

To check Styelint error:-

npx stylelint "\*_/_.{css,scss}"

To check Eslint error:-

npx eslint .

React Testing Library

```

npm test

```

### Deployment

You can deploy this project using:

- Github Pages.

- Render

- Netlify

(back to top)


## 👥 Authors 

👤 **Besufekad Alemu**

- GitHub: [@Besufekad-HAZ](https://github.com/Besufekad-HAZ)

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

- LinkedIn: [@besura](www.linkedin.com/in/besura)

(back to top)


## 🔭 Future Features 

- [ ] **[Adding_full_functionality_to_the_Air-Pollution-Data]**

- [ ] **[Adding_Full_Responsiveness_and_flexibility]**

- [ ] **[Adding_backend_and_databases]**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Besufekad-HAZ/React-Capstone-Air-Pollution/issues).

(back to top)


## ⭐️ Show your support 

If you like this project rate it and give it a star.

(back to top)


## 🙏 Acknowledgments 

--> I would like to thank the [Microverse team](https://www.microverse.org/) for allowing us to work on this Air Pollution Data React Capstone project.

--> I would like to thank [Nelson Sakwa on Behance](https://www.behance.net/sakwadesignstudio) for original design idea.

## ❓ FAQ 

- **Do i need node installed?**

  - Yes...

- **Do i need internet Access?**

  - Yes, you do. Because the API is from the Live source, it needs an internet access to perform requests.

(back to top)


(back to top)


## 📝 License 

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

(back to top)