https://github.com/rudicarrilloypr/my-air-quality-app
mobile web application to check and provide Mexico's current air pollution quality and beautiful pictures of iconic Mexico places, coming from OpenWeather and Unsplash API.
https://github.com/rudicarrilloypr/my-air-quality-app
air-quality mexico pollution
Last synced: 6 months ago
JSON representation
mobile web application to check and provide Mexico's current air pollution quality and beautiful pictures of iconic Mexico places, coming from OpenWeather and Unsplash API.
- Host: GitHub
- URL: https://github.com/rudicarrilloypr/my-air-quality-app
- Owner: rudicarrilloypr
- Created: 2023-08-05T00:56:29.000Z (about 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-08-10T11:10:07.000Z (about 2 years ago)
- Last Synced: 2025-03-30T07:51:14.051Z (7 months ago)
- Topics: air-quality, mexico, pollution
- Language: JavaScript
- Homepage: https://airpurity-mx.netlify.app/
- Size: 94.1 MB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Air Purity App ☁️
# 📗 Table of Contents
- [📖 Air Purity App](#--air-purity-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [👀 Sneak Peak (Author's App presentation)](#sneak-peak)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors ](#-authors-)
- [🙏🏻 Acknowledgements ](#-acknowledgements-)
- [🔮 Future Features](#-future-features)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [❓ FAQ (OPTIONAL) ](#-faq-optional-)
- [📝 License ](#-license-)
**Air Purity Mx** mobile web application to check and provide Mexico's current air pollution quality and beautiful pictures of iconic Mexico places, coming from OpenWeather and Unsplash API.
## 🛠 Built With
- React APP
- Redux
- Open Weather API
### Tech Stack
Client
Server
Database
### Key Features
- [X] **Use of React to setup de project.**
- [X] **Recieve API for pollution database.**
## 👀 Sneak Peak (Author's video presentation)
[Sneak Peak 👀](https://www.loom.com/share/7c9db9f3d8214762b3f283bd80194968?sid=46e69e37-85f8-428a-849a-5e919f10ed5c)
[Click here](https://airpurity-mx.netlify.app/) to see the project's deployment.
## 💻 Getting Started
To get a local copy up and running, follow these steps.
### Prerequisites
Before you proceed, ensure that you have the following installed on your machine:
- Node.js (v12 or above)
- npm (Node Package Manager)
### Setup
Clone this repository to your desired folder:
```sh
git clone git@github.com:rudicarrilloypr/my-air-quality-app.git
```
### Install
Install the project dependencies with:
```sh
npm install
```
### Usage
To run the project, execute the following command:
```sh
npm run build
```
### Run tests
To run tests, run the following command:
```sh
npm start
```
- Open your web browser and visit http://localhost:8080.
- You should now see Air Purity application running in your browser.
👤 **Rudi Carrillo**
- GitHub: [@rudicarrilloypr](https://github.com/rudicarrilloypr)
- Twitter: [@__rudicarrillo](https://twitter.com/__rudicarrillo)
- LinkedIn: [Rudi Carrillo](https://www.linkedin.com/in/rudi-carrillo/)
- Instagram: [@__rudicarrillo](https://www.instagram.com/_rudicarrillo/)
I'd like to express my gratitude to everyone who made this project possible.
- Original design idea by **Nelson Sakwa** on **Behance**.
- Mexico's pictures via **Unsplash**
Thanks again to everyone who believed in this project and helped make it a reality!
## 🔮 Future Features
- style updates
- desktop version
- more information
- more Data funcions and sections
Contributions are welcome! If you find any bugs or want to enhance the project with new features, please follow these steps:
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make the necessary changes and commit them.
4. Push your changes to your forked repository.
5. Submit a pull request describing your changes.
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!
## ❓ FAQ
- **How do I set up the project?**
- Clone the repository from GitHub, and see the [Setup](#setup) section above for details.
- **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.