Skip to content

Latest commit

ย 

History

History
92 lines (56 loc) ยท 2.81 KB

README.md

File metadata and controls

92 lines (56 loc) ยท 2.81 KB

Air Police 1.0

We belive that the first step towards elemintaing a bad habit is by watching it, AirPloice A mobile web application to check a list of countries Air Quailty index, and it's contents.

Using OpenWeatherAirQuailty API that provides numeric data about each country, and present it in the app.

Built With

  • React, Redux, Routers, Bootstrap ~ Javascript Libraries
  • React Testing Library and Jest ~ Unit and integration Testing
  • SCSS ~ Custom Styling
  • Netlify ~ Production Deployment

Live Demo

Live Demo

Getting Started

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

  • From your terminal enter in sequence
    • git clone https://github.com/od-c0d3r/air-police.git
    • code air-police

Available Scripts

In the project directory, you can run:

  • npm install

    • Install the project dependencies.
  • 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.
    • Coming Soon
  • 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.

    • The build is minified and the filenames include the hashes.
      Your app is ready to be deployed!

Coders

๐Ÿ‘ค Omar Rashad

๐Ÿค Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a โญ๏ธ if you like this project!

Acknowledgments

These resources helped me during the development process:

  • Best React-Redux codebase orgnization. ~ Link
  • React routes in seperate file. ~ Link
  • Open Weather API ~ Link
  • Country Location data ~ Link

License

This project is MIT licensed.

๐Ÿ“ Todo

  • Feature: Get users live location and rate thier air quailty index.
  • Add maps images for each country.
  • Add navigation animation between pages.
  • Re-design colors and layout.