rudicarrilloypr / my-air-quality-app

mobile web application to check and provide Mexico's current air pollution quality and beautiful pictures of iconic Mexico places, coming from OpenWeather and Unsplash API.

Air Purity App ☁️

📗 Table of Contents

• 📖 Air Purity App
• 🛠 Built With
  • Tech Stack
  • Key Features
• 👀 Sneak Peak (Author's App presentation)
• 🚀 Live Demo
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Run tests
• 👥 Authors
• 🙏🏻 Acknowledgements
• 🔮 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 Air Purity App

Air Purity Mx mobile web application to check and provide Mexico's current air pollution quality and beautiful pictures of iconic Mexico places, coming from OpenWeather and Unsplash API.

🛠 Built With

• React APP
• Redux
• Open Weather API

Tech Stack

Client

• JavaScript

Server

• Local Storage

Database

• JavaScript

Key Features

• Use of React to setup de project.
• Recieve API for pollution database.

(back to top)

👀 Sneak Peak (Author's video presentation)

Sneak Peak 👀

(back to top)

🚀 Live Demo

Click here to see the project's deployment.

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

Before you proceed, ensure that you have the following installed on your machine:

• Node.js (v12 or above)
• npm (Node Package Manager)

Setup

Clone this repository to your desired folder:

  git clone [email protected]:rudicarrilloypr/my-air-quality-app.git

Install

Install the project dependencies with:

  npm install

Usage

To run the project, execute the following command:

  npm run build

Run tests

To run tests, run the following command:

  npm start

• Open your web browser and visit http://localhost:8080.
• You should now see Air Purity application running in your browser.

(back to top)

👥 Authors

👤 Rudi Carrillo

• GitHub: @rudicarrilloypr
• Twitter: @__rudicarrillo
• LinkedIn: Rudi Carrillo
• Instagram: @__rudicarrillo

(back to top)

🙏🏻 Acknowledgements

I'd like to express my gratitude to everyone who made this project possible.

• Original design idea by Nelson Sakwa on Behance.
• Mexico's pictures via Unsplash

Thanks again to everyone who believed in this project and helped make it a reality!

🔮 Future Features

• style updates
• desktop version
• more information
• more Data funcions and sections

(back to top)

🤝 Contributing

Contributions are welcome! If you find any bugs or want to enhance the project with new features, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make the necessary changes and commit them.
4. Push your changes to your forked repository.
5. Submit a pull request describing your changes.

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, please consider supporting us! Your support helps us to continue developing and improving our project for everyone to enjoy. Whether it's a small donation, sharing the project with your friends, or contributing your skills and expertise, every little bit makes a huge difference. With your support, we can create something truly amazing together. Thank you for being a part of our community and helping us to make a difference!

(back to top)

❓ FAQ

• How do I set up the project?

  • Clone the repository from GitHub, and see the Setup section above for details.

• How can I contribute to the project?

  1. Fork the repository on GitHub.
  2. Create a new branch for your changes using git checkout -b my-feature-branch.
  3. Make your changes and commit them with descriptive commit messages.
  4. Push your changes to your forked repository.
  5. Submit a pull request to the original repository.
  6. Wait for feedback and iterate on your changes as needed.

(back to top)

📝 License

This project is MIT licensed.

(back to top)