SkyForcaster - Your Weather Forecast App

1. Overview

SkyForcaster is a modern weather forecasting app that provides real-time weather updates and a 5-day forecast. The app allows users to search for cities, view detailed weather data, and save favorite locations for easy access. Built with Android Jetpack Compose and Kotlin, it emphasizes simplicity, efficiency, and user-friendly navigation.

2. User Stories & App Architecture 🌟

Before development, I carefully crafted user stories to guide the app’s functionality, focusing on a smooth user experience. Below is a visual representation of the architecture and screen flow:

User Stories, Architecture & Screen Flow

(Above: Visual architecture diagram and screen flow including user navigation between home, search, and details pages.)

https://app.eraser.io/workspace/uVbwx7ycfVLUX3ygdicJ?origin=share

Unit Testing

Comprehensive unit tests were implemented to ensure app stability and reliable functionality.

3. Features

• Real-time Weather Data: Displays live weather updates for any city.
• 5-Day Forecast: A detailed forecast for the next five days, updated every 3 hours.
• Favorites Management: Save and manage favorite cities for quick access.
• Search Feature: Instantly search for cities and view their detailed weather conditions.
• Detailed Weather View: Get in-depth weather details like temperature, wind speed, and humidity.
• Seamless Navigation: Navigate between different app screens using the Android Navigation Component.

4. Setup and Installation

Prerequisites

• Android Studio Bumblebee or later
• Kotlin
• Gradle: (Handled by Android Studio)
• OpenWeatherMap API Key

Steps

1. Clone the repository:

   git clone https://github.com/yourusername/skyforcaster.git

2. Open the project in Android Studio:
   • Select "Open an existing project" and choose the cloned project folder.
3. Configure API Key:
   • In Constant.kt, replace the placeholder with your API key:

   apiKey=your_api_key_here

4. Build & Run:
   • Sync Gradle and press Shift + F10 to run the app on an emulator or physical device.

5. Screenshots 📸

Home Screen

Search and Favorites

Detailed Weather View

6. Key Components

• WeatherViewModel: Handles state management and API calls for weather data.
• Jetpack Compose: Used for the entire UI, enabling a declarative approach.
• Navigation Component: Ensures smooth transitions between app screens.

7. API Integration

The app integrates with the OpenWeatherMap API for real-time data. Make sure to include your API key as instructed above.

8. Contribution

I welcome contributions! Feel free to submit a pull request or report an issue. Let’s build a better weather app together!

---

SkyForcaster is your reliable companion for weather updates, designed for ease of use and accurate forecasting. 🌤️