https://github.com/sergio-usma/airpoll-colombia-app
AirPoll is a project that aims to provide information about the air quality in the most important cities in Colombia. Besides the Air Quality Index, the API returns data about polluting gases, such as Carbon monoxide (CO), Nitrogen monoxide (NO), Nitrogen dioxide (NO2), Ozone (O3), Sulphur dioxide (SO2), Ammonia (NH3), and particulates (PM2.5 PM10)
https://github.com/sergio-usma/airpoll-colombia-app
air-quality microverse react
Last synced: about 1 month ago
JSON representation
AirPoll is a project that aims to provide information about the air quality in the most important cities in Colombia. Besides the Air Quality Index, the API returns data about polluting gases, such as Carbon monoxide (CO), Nitrogen monoxide (NO), Nitrogen dioxide (NO2), Ozone (O3), Sulphur dioxide (SO2), Ammonia (NH3), and particulates (PM2.5 PM10)
- Host: GitHub
- URL: https://github.com/sergio-usma/airpoll-colombia-app
- Owner: sergio-usma
- License: mit
- Created: 2023-08-02T21:39:01.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-05T19:39:24.000Z (about 2 years ago)
- Last Synced: 2025-09-23T10:02:01.559Z (about 1 month ago)
- Topics: air-quality, microverse, react
- Language: JavaScript
- Homepage: https://airpollution-colombia.netlify.app/
- Size: 187 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Air Pollution Colombia
# 📗 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)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
**AirPoll** is a project that aims to provide information about the air quality in the most important cities in Colombia. Besides the Air Quality Index, the API returns data about polluting gases, such as Carbon monoxide (CO), Nitrogen monoxide (NO), Nitrogen dioxide (NO2), Ozone (O3), Sulphur dioxide (SO2), Ammonia (NH3), and particulates (PM2.5 and PM10).
The application was built using the following technologies:
The following features are available:
- **Filter a city by query using the searchbar**
- **Render the most important cities in Colombia, with location and population data**
- **Get the Air Quality Index (AQI) of a city from the OpenWeather API**
- **Render the most important polluting gases in a city**
- [Click here](https://airpollution-colombia.netlify.app/) to see the live demo on Netlify.com
- [Click here](https://www.loom.com/share/9c56c18a935d4327810e737f6ff9e979?sid=fb54579c-d596-4094-9876-5717154ac6ec) to see a video presentation of the project
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
```sh
npm install -g node
```
### Setup
Clone this repository to your desired folder:
```sh
cd my-folder
git clone git@github.com:sergio-usma/airpoll-colombia-app.git
```
### Install
Install this project with:
```sh
npm install
```
### 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 using:
```sh
npm run build
```
👤 **Author**
- GitHub: [@sergio-usma](https://github.com/sergio-usma)
- Twitter: [@VonUsma](https://twitter.com/vonusma)
- LinkedIn: [Sergio Andres Usma](https://www.linkedin.com/in/sergiousma/)
- [ ] **Add more countries data**
- [ ] **Generate a comparative graph about changes through the time**
- [ ] **Add a better UI/UX design**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project, please consider supporting us! Your support helps us to continue developing and improving our project for everyone to enjoy. Whether it's a small donation, sharing the project with your friends, or contributing your skills and expertise, every little bit makes a huge difference. With your support, we can create something truly amazing together. Thank you for being a part of our community and helping us to make a difference!
I would like to thank Microverse for this amazing opportunity to learn with them and for the support they give me to make this possible. Besides I want to recognize the [Original design](https://www.behance.net/gallery/31579789/Ballhead-App-(Free-PSDs)) idea by [Nelson Sakwa on Behance](https://www.behance.net/sakwadesignstudio).
- **How do I set up the project?**
- Clone the repository from GitHub.
- **How can I contribute to the project?**
1. Fork the repository on GitHub.
2. Create a new branch for your changes using git checkout -b my-feature-branch.
3. Make your changes and commit them with descriptive commit messages.
4. Push your changes to your forked repository.
5. Submit a pull request to the original repository.
6. Wait for feedback and iterate on your changes as needed.
This project is [MIT](./LICENSE) licensed.