Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/rileymanda/air-quality

Air-quality is a React full stack web-app that displays numeric air-quality data from various weather stations.
https://github.com/rileymanda/air-quality

axios react-bootstrap react-jest react-testing-library reactjs redux-tookit styled-components

Last synced: about 1 month ago
JSON representation

Air-quality is a React full stack web-app that displays numeric air-quality data from various weather stations.

Awesome Lists containing this project

README 

        






  logo

  



  
Air Quality






# 📗 Table of Contents



- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

    - [🚀 Live Demo](#live-demo)

    - [🚀 Project Presentation](#project-presentation)

- [💻 Getting Started](#getting-started)

  - [Prerequisites](#prerequisites)

  - [Setup](#setup)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🀝 Contributing](#contributing)

- [⭐ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ (OPTIONAL)](#faq)

- [📝 Attribution](#attribution)

- [📝 License](#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.

 logo

  logo



## 🛠 Built With 



### Tech Stack 



  React

  



  Redux

  



  Node js

  



  Axios

  



 

  API

  



 

  React Bootstrap

  



 

  React Testing Library

  



## 🛠 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](https://air-quality-e96p.onrender.com)



## 🚀 Project Presentation 



- [Project Presentation ](https://www.loom.com/share/a0e8aafa6cdf45a9a7a0e07eac834d92?sid=fc3729f8-0efd-439c-a260-7991e9cddd6c)



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



```sh

cd my-folder

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

```



### Install



Install this project with:



```sh

  cd my-project

  npm i

```



### Usage



To run the project, execute the following command:



```sh

  npm start

```



### Run tests



To run tests, run the following command:



```sh

  npm test

```



### Deployment



You can deploy this project using:

    

```sh

    npm run build

```

 ```sh

    gh-pages deploy --dist build

```



(back to top)



## 👥 Authors 



👀 **RileyManda**



- GitHub: [@RileyManda](https://github.com/RileyManda)

- Twitter: [@rilecodez](https://twitter.com/rileycodez)

- LinkedIn: [rileymanda](https://www.linkedin.com/in/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](https://github.com/RileyManda/Air-quality/issues).



(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](https://github.com/microverseinc), 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

](https://www.behance.net/gallery/31579789/Ballhead-App-(Free-PSDs)) 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](https://nodejs.org/en).



(back to top)



## 👥 Attribution 

- This project is based on the Original design by: [Nelson Sakwa

](https://www.behance.net/gallery/31579789/Ballhead-App-(Free-PSDs))

- Original logo design from: [Svgrepo](https://www.svgrepo.com/)



## 📝 License 



[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](./LICENSE)



(back to top)