lordksix's Air Quality 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 (OPTIONAL)
• 📝 License

📖 [lordksix's Air Quality App]

lordksix's Air Quality App is a web application where the user can check a list of metrics (air pollution) using React and Redux and REST API services. check out this loom recording a video demostration and description.

(back to top)

🛠 Built With

Tech Stack

Client

• HTML5
• CSS
• JavaScript

Framework

• React

Key Features

• Setup React App
• Implement SPA using React Router
• Connect to Open Weather Map API
• Connect to Map Box API
• Implement current, forecast and historical air quality pages
• Implement forecast and historical air quality detailed pages
• Implement menu modal
• Add integration tests
• Add pure function tests

🚀 Live Demo

You can find a live demo in HERE.

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps. To run local server or to make any modifications to the project NPM and Node.js must be installed.

Prerequisites

In order to run this project you need: To clone or fork and run it in a browser

Setup

Clone this repository to your desired folder:

For example, using Ubuntu:

  cd my-desired-folder
  git clone git@github.com:lordksix/webmetrics-webapp-cra.git

For more information on how to clone or fork a repository:

• How to clone a repo
• How to fork a repo

If you want to make any kind of change or modification, Node.Js and NPM is necesary. For more information on how to install node.js and npm:

• Downloading and installing Node.js and npm

Install

To install dependencies, the following command must be run in the terminal:

  cd webmetrics-webapp-cra
  npm install

Usage

In the project directory, you can 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.

  npm run lint

This will check Linter error and quick fix when possible to fix.

  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!

  npm run eject

Note: this is a one-way operation. Once you eject, you can't go back!

If you aren't satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

  npm run deploy

Deploys the App to the gh-pages from of the current repository.

Run tests

Launches the test runner in the interactive watch mode.

  npm test

Deployment

This project is deployed using Vercel.

Go to 🚀 Live Demo to check it out.

(back to top)

👥 Authors

👤 Author

• GitHub: @lordksix
• LinkedIn: @wladpasquel
• Medium: @wladimir.pasquel

(back to top)

🔭 Future Features

Future changes:

• Add refresh data button.
• Add Weather Forecast.

(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, I encourage you to clone, fork and contribute. Our community and knowledge grows with each engagement.

(back to top)

🙏 Acknowledgments

I would like to thank Open Weather and Map Box for the API and Nelson Sakwa for the design idea behind for this project.

(back to top)

❓ FAQ

• Do I need a IDE or a special text editor to make changes?

  • No, you don't. You can use NotePad to make changes.

(back to top)

📝 License

This project is MIT licensed.

(back to top)