Air Quality

📗 Table of Contents

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

📖 Air-quality

Air-quality is a full stack app that displays numeric air-quality data from various weather stations.The applications gets data from the api using axios and updates its states using redux-toolkit.Ths application was developed with quality and responsiveness in mind using react test library for TDD and react-boostrap for the ui.

🛠 Built With

Tech Stack

React

• React.js

Redux

• Redux-toolkit

Node js

• Redux-toolkit

Axios

• Axios

API

• Open AQ API

React Bootstrap

• React Bootstrap

React Testing Library

• React Bootstrap

🛠 Key Features

Features

Home Page:Display Air Quality Data Details Page:Display Air Quality Data details Filter:Filter data based on keywords

(back to top)

🚀 Live Demo

• Live Demo

🚀 Project Presentation

• Project Presentation

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

Setup

Clone this repository to your desired folder:

cd my-folder
git clone https://github.com/RileyManda/air-quality.git

Install

Install this project with:

  cd my-project
  npm i

Usage

To run the project, execute the following command:

  npm start

Run tests

To run tests, run the following command:

  npm test

Deployment

You can deploy this project using:

    npm run build

   gh-pages deploy --dist build

(back to top)

👥 Authors

👤 RileyManda

• GitHub: @RileyManda
• Twitter: @rilecodez
• LinkedIn: rileymanda

(back to top)

🔭 Future Features

• [Search and filter by city]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

Show your support 🌟

Thank you for taking the time to explore this project! Your support means a lot to me. If you find my project valuable and would like to contribute, here is one way you can support me:

• Star the project ⭐️: Show your appreciation by starring this GitHub repository. It helps increase visibility and lets others know that the project is well-received.

• Fork the project 🍴 🎣: If you're interested in making improvements or adding new features, feel free to fork the project. You can work on your own version and even submit pull requests to suggest changes.

• Share with others 🗺️: Spread the word about this project. Share it on social media, mention it in relevant forums or communities, or recommend it to colleagues and friends who might find it useful.

(back to top)

🙏 Acknowledgments

I would like to express my sincere gratitude to Microverse, the dedicated reviewers, and collaborators. Your unwavering support, feedback, and collaborative efforts have played an immense role in making this journey a resounding success. I am truly grateful for your contributions and for being an integral part of my achievements. I would like to also send out special thanks to Nelson Sakwa for the original Ux design that inspired this project. Thank you for your continued support.

(back to top)

❓ FAQ

• Question_1

  Do I have to use the vs code specifically?

  • Answer_1

    You can use any code editor of your choice.
    

• Question_2

  Where can I download node JS for installation?

  • Answer_2

  Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine. It can be downloaded here.

(back to top)

👥 Attribution

• This project is based on the Original design by: Nelson Sakwa
• Original logo design from: Svgrepo

📝 License

(back to top)