Skip to content

ikramhasan/aqi-air-quality-near-me

Repository files navigation

project-logo

AQI: Air Quality Near Me

Breathe easy! Get Real-time air quality & personalized health tips.


Table of Contents

📍 Overview

Breathe easy, breathe informed: AQI: Air Quality Near Me Concerned about air quality? AQI: Air Quality Near Me is your one-stop solution for real-time information and personalized health advice.

🧩 Features

  • Instant air quality: No more guesswork! Get the current AQI index for your exact location or search any city worldwide.
  • Detailed breakdown: See levels of key pollutants like PM2.5, ozone, and more, and understand their impact on your health.
  • Health recommendations tailored to you: Get personalized advice based on the AQI and your health profile.
  • Plan your day effectively: Choose outdoor activities with confidence based on air quality conditions.
  • Protect your health: Receive timely alerts and recommendations for sensitive groups like children, pregnant women, and those with respiratory conditions.
  • Stay informed: Track air quality trends and historical data to understand patterns and make informed decisions.

🗂️ Repository Structure

├── assets
│   ├── logo
│   │   └── logo.png
│   └── svg
│       └── *.svg
├── lib
│   ├── src
│   │   ├── cubit
│   │   │   ├── waqi_cubit.dart
│   │   │   ├── waqi_state.dart
│   │   │   ├── aqi_search_cubit.dart
│   │   │   └── aqi_search_state.dart
│   │   ├── data
│   │   │   ├── data.dart
│   │   │   └── table_models.dart
│   │   ├── models
│   │   │   ├── aqi_response.dart
│   │   │   └── failure.dart
│   │   ├── presentation
│   │   │   ├── components
│   │   │   │   ├── about_widget.dart
│   │   │   │   ├── pollutant_amount_box.dart
│   │   │   │   └── pollutant_info_box.dart
│   │   │   ├── app.dart
│   │   │   ├── aqi_page.dart
│   │   │   ├── home_page.dart
│   │   │   ├── search_page.dart
│   │   │   ├── settings_page.dart
│   │   │   └── tab_page.dart
│   │   ├── repositories
│   │   │   └── waqi_repository.dart
│   ├── main.dart
├── .gitignore
├── .env
├── analysis_options.yaml
├── pubspec.yaml
└── README.md

⚙️ Installation

  1. Clone the repository
    git clone https://github.com/ikramhasan/aqi-air-quality-near-me.git
  2. Install the dependencies
    flutter pub get
  3. Run the app
    flutter run

🤝 Contributing

Contributions are welcome! Here are several ways you can contribute:

Contributing Guidelines
  1. Fork the Repository: Start by forking the project repository to your local account.
  2. Clone Locally: Clone the forked repository to your local machine using a git client.
    git clone https://github.com/ikramhasan/aqi-air-quality-near-me.git
  3. Create a New Branch: Always work on a new branch, giving it a descriptive name.
    git checkout -b new-feature-x
  4. Make Your Changes: Develop and test your changes locally.
  5. Commit Your Changes: Commit with a clear message describing your updates.
    git commit -m 'Implemented new feature x.'
  6. Push to local: Push the changes to your forked repository.
    git push origin new-feature-x
  7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
  8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

🎗 License

This project is protected under the Apache License 2.0 License. For more details, refer to the LICENSE file.

Return

About

Breathe easy! Get Real-time air quality & personalized health tips.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published