notnotrachit / GitGoing

1 stars 11 forks source link

Weather Dashboard

A simple, interactive weather dashboard built with Streamlit that allows users to check current weather conditions for any city. This project is designed as a learning exercise for Git and GitHub collaboration.

🌟 Features

πŸš€ Getting Started

Prerequisites

Installation

  1. Clone the repository

  2. Create a virtual environment (recommended)

    python -m venv venv
    source venv/bin/activate  # On Windows, use: venv\Scripts\activate
  3. Install dependencies

    pip install -r requirements.txt
  4. Get an API Key

    • Sign up at OpenWeatherMap
    • Generate an API key from your account dashboard
    • Save your API key securely

Running the App

streamlit run main.py

🀝 Contributing

We welcome contributions from developers of all skill levels! This project is designed to help you learn Git and GitHub workflows.

How to Contribute

  1. Fork the repository
  2. Create a new branch for your feature
    git checkout -b feature/your-feature-name
  3. Make your changes
  4. Commit your changes
    git add .
    git commit -m "Add meaningful commit message"
  5. Push to your fork
    git push origin feature/your-feature-name
  6. Open a Pull Request

Guidelines

πŸ“ Requirements

streamlit>=1.10.0
requests>=2.28.0
python-dotenv>=0.20.0

🚨 Known Issues

See the Issues page for a list of known issues and planned improvements.

πŸ“„ License

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

πŸ™ Acknowledgments