Skip to content

Latest commit

 

History

History
160 lines (118 loc) · 4.02 KB

README.md

File metadata and controls

160 lines (118 loc) · 4.02 KB
Raw

Weather App

A Django-based Weather App that fetches and displays current weather data for any city. The application integrates with a weather API to provide real-time weather information, including temperature, humidity, wind speed, and more.

Features

  • Search weather details by city name.
  • Display of temperature, humidity, wind speed, and general weather conditions.
  • Responsive and user-friendly UI.
  • Error handling for invalid city names or network issues.
  • Caching of API responses for better performance (optional).

Installation

Follow these steps to set up the Weather App on your local machine:

Prerequisites

Steps

  1. Clone the repository:

    git clone https://github.com/SimranShaikh20/WeatherApplication
cd Weather-App

  2. Create a virtual environment and activate it:

    python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

  3. Install the required dependencies:

    pip install -r requirements.txt

  4. Set up environment variables: Create a .env file in the project root and add your weather API key:

    WEATHER_API_KEY=your_api_key_here

  5. Apply migrations and run the development server:

    python manage.py migrate
python manage.py runserver

  6. Open the application in your browser at:

    http://127.0.0.1:8000/

How to Get a Weather API Key

  1. Go to the OpenWeatherMap API website.
  2. Sign up for a free account if you don’t already have one.
  3. After logging in, navigate to the API Keys section of your profile.
  4. Generate a new API key or use the default one provided.
  5. Copy the API key and add it to the .env file as: 
    WEATHER_API_KEY=your_api_key_here

How to Get a Search Engine API Key

  1. Go to the Google Custom Search API website.
  2. Sign in with your Google account.
  3. Navigate to the Get Started section and enable the Custom Search JSON API.
  4. Create a new search engine and configure it as per your requirements.
  5. Copy the API key provided in the Credentials section.
  6. Add the API key to your .env file as: 
    SEARCH_ENGINE_API_KEY=your_search_engine_api_key_here

Usage

  1. Enter the city name in the search bar.
  2. Press the "Search" button.
  3. View the weather details for the entered city.

Project Structure

Page

Weather-App/
├── weather_app/        # Main Django app containing settings and URLs
├── templates/          # HTML templates for the app
├── static/             # CSS, JavaScript, and image files
├── .env                # Environment variables file
├── manage.py           # Django management script
├── requirements.txt    # Python dependencies
└── README.md           # Project documentation

API Integration

The app uses the OpenWeatherMap API to fetch weather data. Make sure to generate an API key and add it to your .env file as described in the installation steps.

Example API Request

GET https://api.openweathermap.org/data/2.5/weather?q=city_name&appid=your_api_key

Screenshots

Home Page

Home Page

Weather Details

Weather Details

Contributing

  1. Fork the repository.
  2. Create a feature branch: 
    git checkout -b feature-name
  3. Commit your changes: 
    git commit -m "Add your message here"
  4. Push to the branch: 
    git push origin feature-name
  5. Create a Pull Request.

Acknowledgments