NoelLincoln / air-pollution-stats

This application provides statistics about air pollution. It is built with react ,redux and openweather api

📗 Table of Contents

• 📖 About the Project

  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo

• 💻 Getting Started

  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests

• 👥 Authors

• 🔭 Future Features

• 🤝 Contributing

• ⭐️ Show your support

• 🙏 Acknowledgements

• 📝 License

📖 Air Pollution Stats

Air Pollution Stats is a webapp built with the aim of sharing information about air pollution for various regions around the globe.

🛠 Built With

Tech Stack

• HTML
  
• CSS
• React
• Redux

Key Features

• SPA - Sigle Page Application
• User Friendly

(back to top)

🚀 Live Demo

• Live Demo Link

📹 Video Presentation

• Video link

(back to top)

💻 Getting Started

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

Prerequisites

In order to set up and run the application you need:

• A code editor preferably Visual Studio Code
• A web browser preferably Google chrome.

Basic requirements are needed in order to fully understand how the project fully works :

• Basic knowledge of HTML, CSS, and React.
• Intermediate knowledge of React-Redux
• How to work with Git and GitHub.

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/NoelLincoln/air-pollution-stats/

Install

Install this project with:

  cd air-pollution-stats
  npm install

Usage

To run the project 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

Run tests

To run tests, run the following command:

  npm test

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

Deployment

This project can be deployed on several platforms. Github pages is used for deployment. For detailed steps visit deploy create-react-app.

(back to top)

👥 Authors

👤 Noel Bryant

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

(back to top)

🔭 Future Features

• Desktop Version
• Text to voice

(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 give a ⭐️

(back to top)

🙏 Acknowledgments

I would like to thank Microverse a lot

I would like to acknowledge Nelson Sakwa, the original creator of this design

I would like to thank freepik forallowing me to use their icons

(back to top)

📝 License

This project is MIT licensed.

(back to top)