README.md

AQI Monitor

📗 Table of Contents

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

📖 AQI Monitor

AQI Monitor is a single page application build using react.js and redux, where users can see real time data on Air quality index of more then 250+ major citys around the world.

🛠 Built With

Tech Stack

Client

• React.js
• Redux toolkit
• HTML+CSS

Server

• Open Weather Map
• JSON Bin

Key Features

• Watch Real Time AQI on 250+ citys
• Search and filter Citys
• See Detailed View on citys data including city Population

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

🚀 Presentaion Video

• Video Link

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

• Node
• Browser
• Your favourite code editor

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/devendra-alt/aqi-monitor

Install

Install this project with:

  cd aqi-monitor
  npm install

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:

• Netlify
• Render

(back to top)

👥 Authors

👤 Devendra Mulewa

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

🔭 Future Features

• Adding countries page and filter
• Adding continental filter page

(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 star it and also do consider following me for new JS projects

(back to top)

🙏 Acknowledgments

Special thanks to Nelson Sakwa in Behance for the original design concept used in this project. The design is licensed under the Creative Commons License, and Nelson Sakwa's work served as a valuable inspiration for our project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)