Skip to content

whatcheers/WEATHERORNOT

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

README.md

# Weather Alert App

Weather Alert App is a real-time weather notification system utilizing Flask, Socket.IO, and external weather APIs. It allows users to retrieve and display weather alerts from various feeds and can query specific weather phenomena statistics using the IEM Cow API.

## Features

- Real-time updates of weather feeds using Flask and Socket.IO.
- User inputs for querying specific weather phenomena.
- Dark and light theme support.
- Responsive design suitable for desktop and mobile devices.

## Prerequisites

Before you begin, ensure you have met the following requirements:
- Python 3.6+
- pip (Python package installer)
- Node.js and npm (for compiling and managing JavaScript dependencies)

## Installation

To install Weather Alert App, follow these steps:

1. **Clone the repository:**
   ```bash
   git clone https://github.com/yourusername/weather-alert-app.git
   cd weather-alert-app
  1. Set up a Python virtual environment (optional but recommended):

    python -m venv venv
    source venv/bin/activate  # On Windows use `venv\Scripts\activate`
  2. Install the required Python packages:

    pip install -r requirements.txt

Running the Application

To run Weather Alert App, use the following command from the root directory of the project:

python3 app.py

This will start the Flask server on http://localhost:5000, where you can access the web interface.

Using the Application

  • Setting Refresh Interval: Choose how often you want the feed to update from the dropdown menu.
  • Switching Themes: Select your preferred theme (dark or light) from the theme dropdown.
  • Fetching Weather Stats: Enter the WFO and phenomena code into the input fields and click "Get Cow Stats" to fetch statistics.

Contributing to Weather Alert App

To contribute to Weather Alert App, follow these steps:

  1. Fork this repository.
  2. Create a branch: git checkout -b <branch_name>.
  3. Make your changes and commit them: git commit -m '<commit_message>'
  4. Push to the original branch: git push origin <project_name>/<location>
  5. Create the pull request.

Alternatively, see the GitHub documentation on creating a pull request.

Contact

If you have any questions, please contact us at [email protected].

License

This project uses the following license: MIT License.


### Notes:
- **Repository URL and contact details:** Make sure to replace placeholder URLs and contact details with your actual project repository URL and contact email.
- **Commands and scripts:** Adjust the shell commands and filenames as necessary to fit your project's structure and setup.
- **Dependencies and build scripts:** Ensure any build or runtime dependencies are correctly documented, including any environment variables or configuration files that need to be set or created.

This README provides a comprehensive guide for anyone who wants to understand, use, or contribute to your Weather Alert App. Adjust as necessary to fit the specifics and complexities of your project.

About

Pubes

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published