Air-Pollution-App

React group project

Air Pollution App

📗 Table of Contents

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

📖 [Air-Pollution-App]

[Air-Pollution-App] "Air-Pollution-App" This is the capstone project for react module that used for finding current air pollution data using geographical coordinates (latitude, longitude). The application will allow users to:

• Find the country,
• See the current air pollution gases in this country.

🛠 Built With

React Redux React Bootstrap Hooks

Tech Stack

React Redux

Client

• React
• Redux
• React Bootstrap

Server

• Render

Database

• Restcountries API
• OpenWeatherMap API

Key Features

• [Show-Countries-per-continenet]
• [Show-pollution-Rate]
• [show-gas-combination]

(back to top)

Screenshots

Countries_View

Pollution_View

🚀 Live Demo

• Live Demo Link

Demonstration Video

• Demo-Video

(back to top)

💻 Getting Started

• This project was bootstrapped with Create React App.
• Clone this repo to your local machine
• cd into the folder and run npm install to install all the dependencies.
• Run npm start to start the app.
• Open http://localhost:3000 to view it in the browser.
• The page will reload if you make edits.
• You will also see any lint errors in the console.
• Run npm run build to build the app for production to the build folder.
• It correctly bundles React in production mode and optimizes the build for the best performance.
• The build is minified and the filenames include the hashes.
• Your app is ready to be deployed!

Prerequisites

In order to run this project you need:

• Have visual studio Code in your PC.
• Have a verified GitHub account.
• A code editor
• Nodejs
• NPM
• Have a stable browser version.

Setup

• Create a local directory where you can clone the project.
• Clone this repository to your desired folder using terminal: git clone https://github.com/ReemMohamedAbdelfatah/air-pollution-app.git
• Install the dependencies
• Open the project on a browser

Install

Install this project with:

• Just run npm i to install all dependencies

Usage

To run the project, execute the following command:

• npm run build
• npm run start

Run tests

To run tests, run the following command:

Follow this Link instructions: https://create-react-app.dev/docs/running-tests/

Deployment

You can deploy this project using:

Render

(back to top)

👥 Authors

👤 Reem Muhammed

• GitHub: @github
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [Better_design]
• [Add_map_foreach_country]

(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 the project and feel free to add your own touches.

(back to top)

🙏 Acknowledgments

I would like to thank microverse for the great resources shared. Also I would like to thanks Nelson Sakwa for Original Design Official Behance Page @NelsonSakwa, Api - Open Weather

(back to top)

❓ FAQ

• [How_to_use_the_app?]

  • [I puted a small div in the top explaining how to use tha application]

• [Can_I_Contribute?]

  • [Sure, you're free to contribute and add your own touches]

(back to top)

📝 License

This project is MIT licensed.

(back to top)