ndorrh / air-pollution-data

[Air Pollution Metrics] is an application that provides current, forecast and historical air pollution data for some countries.

Microverse README Template

📗 Table of Contents

• 📗 Table of Contents
• 📖 [your_project_name]
  • 🛠 Built With React Js
    • Key Features
  • 🚀 Live Deployment
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Install
• Deployment
• type npm start
  • Prerequisites
  • Run tests
• type npm test
  • Deployment
• type npm run build
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ
  • 📝 License

📖 [Air Pollution Data Metric]

Describe your project in 1 or 2 sentences.

[Air Pollution Metrics] is an application that provides current, forecast and historical air pollution data for some countries. You can check the pollution index of your country by simply scrolling or searching for it using the search bar and clicking on it to show more details. This application is built with Reactjs and Bootstrap.

🛠 Built With React Js

Key Features

Describe between 1-3 key features of the application.

• [key_feature_1] Shows a List of Countries
• [key_feature_2] Details page you can see polution data for the country clicked
• [key_feature_3] You can search for a country

(back to top)

🚀 Live Deployment

• Click here to see live website

🚀 Live Demo

• Video Description

(back to top)

💻 Getting Started

Prerequisites

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

type cd dirname, after type git clone [https://github.com/ndorrh/air-pollution-data.git]

Install

npm install

Deployment

• To deploy the project

type npm start

• Runs the app in the development mode.
  Automatically your browser should open this link: http://localhost:3000

Prerequisites

• Node js
• VS Code

Run tests

To run tests, run the following command:

type npm test

Deployment

You can deploy this project using:

type npm run build

(back to top)

👥 Authors

👤 Author1

• GitHub: @ndorrh
• Twitter: @NdorrhEbu
• LinkedIn: Deen

(back to top)

🔭 Future Features

• [Sig-up]
• [Log-in]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

Design Inspiration: Nelson Sakwa

(back to top)

❓ FAQ

Add at least 2 questions new developers would ask when they decide to use your project.

• How to clone the application?

  • Kindly copy the repository link and then on your comand line run "git clone "

• How to start the application?

  • On your command line, run "npm start"

(back to top)

📝 License

This project is MIT licensed.

(back to top)