Air-Pollution-Metrics-React

📗 Table of Contents

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

📖 Air-Pollution-Metrics-React

This is a web application that displays green-house gas emission data in Eurppean countries.

The application fetches real live data from the Air pollution API. The application allows users to interact with it by clicking on a specific country which will then display the gas stats for that country's capital.

See video demo.

🛠 Built With

Tech Stack

Client

• React.js
• Sass
• React Bootstrap
• HTML5

Key Features

• Single Page App

• Search bar

• Gitflow

• REST APIs

(back to top)

🚀 Live Demo

• Visit live site.

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

• A browser (e.g. Firefox)
• An IDE (e.g. Vususal Studio Code)
• npm

Setup

To clone this repository to your desired folder, follow the steps below:

Using the command line

• Use the following commands

  cd my-folder
  git clone https://github.com/Timbar09/Air-Pollution-Metrics-React.git

Using GitHub Desktop app

• Follow the steps below

  • Visit this link "https://github.com/Timbar09/Air-Pollution-Metrics-React"
  • Click the green button labelled "code"
  • Select the "Open with GitHub Desktop" option
  • After the GitHub Desktop add opens, click the "clone repo" button

Install

Install this project's dependencies with the following command:

  npm install

Usage

To run the project, execute the following command:

  npm run dev

Run tests

To run tests, run the following command:

  npm test

Deployment

You can deploy this project by running following command:

  npm run deploy

(back to top)

👥 Author

👤 Author	GitHub	Twitter	LinkedIn
Miles Mosweu	@Timbar09	@Milez09	@miles09

(back to top)

🔭 Future Features

• Implement a desktop version.
• Implement more functionality.

(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 it a ⭐️ and let me know what you like in particular.

(back to top)

🙏 Acknowledgments

I would like to thank the whole Microverse community for their help and contributions towards this project.

I would also like to appreciate Nelson Sakwa on Behance for the design template and Flaticon for the home page hero-image and the flag icons.

(back to top)

📝 License

This project is MIT licensed.

(back to top)