Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/alvp01/pollution-metrics

A web-app to measure air pollution globally.
https://github.com/alvp01/pollution-metrics

Last synced: 4 days ago
JSON representation

A web-app to measure air pollution globally.

Host: GitHub
URL: https://github.com/alvp01/pollution-metrics
Owner: alvp01
Created: 2021-11-22T21:42:25.000Z (about 3 years ago)
Default Branch: dev
Last Pushed: 2024-01-15T18:18:08.000Z (about 1 year ago)
Last Synced: 2025-01-08T08:24:02.102Z (9 days ago)
Language: JavaScript
Size: 2.7 MB
Stars: 8
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Pollution Metrics

This app is a two pages mobile web app. The objetive of this app is to get air pollution data from countries all around the world and filter such countries by region.

The first page show the air quality index (AQI) of each country in the filtered region, and the timestamp of when the query was made.

The user is able to click in each of the countries to enter in the details page. This page shows the AQI and the components and particles present in the air in the moment when the query was made.

## App appereance

![appdesign](./app_img.jpg)

## App functionality
**Homepage**

The first page shows to the user a list of countries filtered by region. Each country has its AQI (and a AQI translation to common language) and the timestamp for when the AQI query was made. The user may click a specific country to get more detailed information.

![homepage](./app_img.jpg)

**Country page**

When the user clicks a specific country the app will render the page of such country dynamically, displaying the AQI and the particules in the air of the country's air at the moment of the query.

![country page](./country-page.png)

## Live Link

- [Live demo](https://objective-shaw-384c5d.netlify.app/)

## Future features to add

In the near future I will add:

- Desktop version UI
- Loaders
- Search bar

## Built with

- React
- Redux
- Npn as package manager

## Setup

```
git clone https://github.com/alvp01/book-store.git
cd book-store
npm install
npm start
```
**Note: check the react readme below for more information 👇**

Create React App documentation

## Getting Started with Create React App

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

### Available Scripts

In the project directory, you can run:

#### `npm start`

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.\
You will also see any lint errors in the console.

#### `npm test`

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

#### `npm run build`

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

#### `npm run eject`

**Note: this is a one-way operation. Once you `eject`, you can’t go back!**

If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

### Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).

#### Code Splitting

This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)

#### Analyzing the Bundle Size

This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)

#### Making a Progressive Web App

This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)

#### Advanced Configuration

This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)

#### Deployment

This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)

#### `npm run build` fails to minify

This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)

## After cloning

After cloning go to [OpenWeather](https://openweathermap.org/), register and verify the email. You will get an API key in your inbox.
Then, create a .env in the root folder of the project and create a variable like this:
`APP_REACT_API_KEY=` (without brackets).

## Acknowledgements

- [Nelson Sakwa](https://www.behance.net/gallery/31579789/Ballhead-App-(Free-PSDs)) for the design.
- [OpenWeather](https://openweathermap.org/) for the API.

## Video link

- [Link to the video presentation](https://drive.google.com/file/d/1VJbBlovpTN2J2foGM8G9Xo4nCNRh1628/view?usp=sharing)

## Author

👤 **Abel**
- Github: [@alvp01](https://github.com/alvp01)
- Twitter: [@alvp01](https://twitter.com/alvp01)
- Linkedin: [Abel Lavieri](https://www.linkedin.com/in/abel-lavieri/)

## 🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check the [issues page](https://github.com/alvp01/pollution-metrics/issues)

## 📝 License

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