ouasamine / air-quality

Air Quality Index is a single page app that provide live data about the air quality in different cities. The app uses an external API to fetch data and is built with React.JS, Redux.JS and Javascript.

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
  • 🚀 Live Demo
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Available Scripts
• 👥 Authors
• 🤝 Contributing
• 🙏 Acknowledgements
• 📝 License

Air Quality Index

Air Quality Index is a single page app that provide live data about the air quality in different cities.

Built With

• React.js
• JavaScript

Live Demo

• Live Demo Link

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• A web browser (Chrome, Mozilla, Edge...).
• A packet manager (In the following instruction npm will be used, you can choose any packet manager you like)

Setup

1. Clone this project on your local machine using the following command on your Git Bash: git clone https://github.com/ouasamine/air-quality

2. Browse to project directory cd air-quality

3. Run npm install To install project dependencies (a packet manager is required).

Available Scripts

In the project directory, you can run:

• npm start

  Runs the app in the development mode.
  Open http://localhost:3000 to view it in your browser.

  The page will reload when you make changes.
  You may also see any lint errors in the console.

• npm test

  Launches the test runner in the interactive watch mode.
  See the section about running tests for more information.

• npm run build

  Builds the app for production to the build folder.
  It correctly bundles React in production mode and optimizes the build for the best performance.

Author

👤 Amine

• GitHub: @ouasamine
• Twitter: @ouass_amine
• LinkedIn: LinkedIn

Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Acknowledgments

• Microverse
• Many thanks to Nelson Sakwa whose design was used in this project.

License

This project is MIT licensed.