SA Weather Companion - OPSC6312 POE Android App

📱 Project Overview

SA Weather Companion is a comprehensive Android weather application developed as part of the OPSC6312 (Open Source Coding - Intermediate) Portfolio of Evidence. This app provides real-time weather information for South African cities with a focus on user experience and functionality.

✨ Features

• Real-time Weather Data: Get current weather conditions for any South African city
• Weather Forecasts: View detailed weather forecasts
• Favorites Management: Save and manage your favorite cities
• User Authentication: Secure login and registration system
• Search Functionality: Easy city search with autocomplete
• Responsive UI: Modern, intuitive user interface
• Settings & Profile: Customizable user preferences

🏗️ Project Structure

Part 2/SAWeatherCompanion/SAWeatherComp/
├── app/
│   ├── src/
│   │   ├── main/
│   │   │   ├── java/com/example/capeweather/
│   │   │   │   ├── Activities/
│   │   │   │   ├── Fragments/
│   │   │   │   ├── Models/
│   │   │   │   └── Utils/
│   │   │   └── res/
│   │   ├── test/
│   │   └── androidTest/
│   └── build.gradle.kts
├── gradle/
└── build.gradle.kts

🚀 Getting Started

Prerequisites

• Android Studio Arctic Fox or later
• Android SDK API level 24 or higher
• Kotlin 1.8+
• Gradle 8.0+

Installation

1. Clone the repository:

   git clone https://github.com/Petermolepo/Open-Source-Coding-Intermediate-POE-Android-App.git
   

2. Open the project in Android Studio:

   • Navigate to Part 2/SAWeatherCompanion/SAWeatherComp/
   • Open the project in Android Studio

3. Sync the project with Gradle files

4. Run the application on an emulator or physical device

🔧 Configuration

API Setup

The app uses weather APIs to fetch real-time data. Make sure to:

1. Obtain API keys from your weather service provider
2. Add the API keys to your local.properties file:

   WEATHER_API_KEY=your_api_key_here
   

Firebase Setup

The app includes Firebase integration for authentication:

1. Add your google-services.json file to the app/ directory
2. Configure Firebase Authentication in your Firebase console

📋 Key Components

Activities

• SplashActivity: App launch screen
• AuthActivity: User authentication
• HomePageActivity: Main weather dashboard
• SearchActivity: City search functionality
• FavouritesActivity: Manage favorite cities
• ProfileActivity: User profile management
• SettingsActivity: App settings

Data Models

• WeatherResponse: Weather data structure
• User: User authentication model
• WeatherRepository: Data management layer

🧪 Testing

The project includes comprehensive testing:

• Unit Tests: Located in src/test/
• Instrumented Tests: Located in src/androidTest/
• GitHub Actions: Automated testing workflow

Run tests using:

./gradlew test
./gradlew connectedAndroidTest

📚 Documentation

Additional project documentation can be found in:

• Part 1/: Planning and design documents
• 📌 Planning and Design Document.docx: Comprehensive project planning
• Visual Comparison Table.docx: Feature comparison analysis

🎯 Learning Outcomes

This project demonstrates:

• Android app development with Kotlin
• RESTful API integration
• Firebase authentication
• Material Design implementation
• Unit and integration testing
• Version control with Git
• Agile development practices

👨‍💻 Author

Matale Molepo

• Student ID: [Your Student ID]
• Course: OPSC6312 - Open Source Coding (Intermediate)
• Institution: [Your Institution]

📄 License

This project is developed for educational purposes as part of the OPSC6312 course requirements.

🤝 Contributing

This is an academic project. For educational collaboration or questions, please contact the author.

📞 Support

For technical issues or questions related to this project, please create an issue in this repository.

---

This project was developed as part of the OPSC6312 Portfolio of Evidence at [Your Institution].