Skip to content

caesarc6/JJ_Hack_23

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

64 Commits
 
 
 
 
 
 

Repository files navigation

ClearAir

Overview

ClearAir is a web application designed to raise awareness about air quality and promote eco-friendly habits. Developed during a 2023 hackathon, ClearAir obtained second place for its innovative approach and impactful presentation. The application allows users to check real-time air quality and temperature by entering a ZIP code. It also provides educational pages that suggest sustainable practices like cycling to work and recycling to help reduce carbon emissions.

Features

  • Air Quality Check: Users can enter a ZIP code and view the current Air Quality Index (AQI) and temperature of the location.
  • Eco-Friendly Tips: Offers practical advice on reducing carbon emissions, including benefits of biking and tips on effective recycling.
  • Responsive Design: Ensures a seamless experience across all device types.

Technologies

ClearAir is built using a modern tech stack to ensure high performance and ease of maintenance:

  • Vite.js: A modern, fast front-end build tool.
  • React: Used for building the user interface with efficient updates and rendering.
  • Weatherbit.io API: Provides reliable air quality and temperature data.
  • Material-UI: Supplies icons and components for a clean and intuitive user interface.

Getting Started

Prerequisites

Ensure you have the following installed:

  • Node.js
  • NPM or Yarn
  • WeahterBit.io API key (Just create an account to gain an API key.)

Installation

  1. Clone the repository:

git clone https://github.com/caesarc6/JJ_Hack_23.git

cd JJ_HACK_23

  1. Install dependencies:

npm install or yarn install

  1. Run the application:

npm run dev or yarn dev

The application should now be running on http://localhost:5173/.

License This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments Thanks to Weatherbit.io for providing the API that powers our air quality and temperature data. Special thanks to everyone who participated in the hackathon and helped bring this project to life. Feel free to modify and enhance the README file to better match your project's specifics and your personal style!

About

hackathon '23 submission

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •