Skip to content

AmaraNecib/Khadra

Repository files navigation

🌱 Khadra - Volunteer Plant Irrigation App

Kotlin Version Compose Version

Khadra is an Android application that connects volunteers with plant irrigation opportunities, enabling community-driven plant care through scheduling and tracking of watering activities.

Features ✨

  • Volunteer Registration: Create accounts and manage volunteer profiles
  • Plant Tracking: View plant locations and irrigation requirements
  • Watering Scheduling: Schedule and manage watering tasks
  • Notifications: Reminders for upcoming watering duties
  • Progress Tracking: Monitor plant health and watering history
  • Community Map: Interactive map showing plants needing care

Technologies Used 🛠️

  • Jetpack Compose - Modern Android UI toolkit
  • Kotlin Coroutines - Asynchronous programming
  • ViewModel & LiveData - Lifecycle-aware data management
  • Room Database - Local data persistence
  • Firebase - Authentication and cloud Datastore (if used)
  • Material Design 3 - UI components and theming

Installation & Setup 🚀

Prerequisites

  • Android Studio Ladybug Feature Drop (2024.2.2)
  • Android SDK 33+
  • Kotlin 2.0.0

Steps

  1. Clone the repository

    git clone https://github.com/AmaraNecib/Khadra.git
  2. Open in Android Studio

    • Select "Open an Existing Project"
    • Choose the cloned directory
  3. Build and Run

    • Click the ▶️ Run button in Android Studio
    • Choose a connected device or emulator

Configuration ⚙️

Firebase Setup (if applicable)

not yet

TPs

You can see the TPs folder for the tasks description.

Contributing 🤝

We welcome contributions! Please follow these guidelines:

  1. Fork the repository
  2. Create a feature branch
    git checkout -b feature/your-feature-name
  3. Commit changes
    • Follow Conventional Commits format
    • Example: feat: add user registration screen
  4. Push and create Pull Request
    • Ensure code follows Kotlin style guide
    • Include test coverage for new features
    • Update documentation when applicable

Code Style

  • Use meaningful variable names
  • Follow official Kotlin coding conventions
  • Keep composables small and focused
  • Use ViewModel for business logic

License 📄

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

Contact 📧

For questions or suggestions:

Project Maintainer: [Amara Necib]
GitHub Issues: Create New Issue

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages