Air Pollution Colombia

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 AirPoll Colombia

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

🛠 Built With

Tech Stack

The application was built using the following technologies:

• HTML5
• CSS3
• React.js
• Redux
• JavaScript
• NPM

Key Features

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

(back to top)

🚀 Live Demo

• Click here to see the live demo on Netlify.com
• Click here to see a video presentation of the project

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

npm install -g node

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone [email protected]:sergio-usma/airpoll-colombia-app.git

Install

Install this project with:

npm install

Usage

To run the project, execute the following command:

npm start

Run tests

To run tests, run the following command:

npm run test

Deployment

You can deploy this project using:

npm run build

(back to top)

👥 Authors

👤 Author

• GitHub: @sergio-usma
• Twitter: @VonUsma
• LinkedIn: Sergio Andres Usma

(back to top)

🔭 Future Features

• Add more countries data
• Generate a comparative graph about changes through the time
• Add a better UI/UX design

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

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!

(back to top)

🙏 Acknowledgments

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 idea by Nelson Sakwa on Behance.

(back to top)

❓ FAQ (OPTIONAL)

• 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.

(back to top)

📝 License

This project is MIT licensed.

(back to top)