🌿 GrabTrash Mobile

GrabTrash (EcoTrack) is a modern Android mobile application designed to revolutionize waste management by connecting users with trash pickup services. Schedule pickups, track your orders, and contribute to a cleaner environment!

📑 Table of Contents

Features
Tech Stack
Getting Started
Project Structure
App Architecture
API Documentation
Testing
Contributing
Team
License

✨ Features

👤 For Users

Feature	Description
User Authentication	Secure login/registration
Security Questions	Password recovery through security questions
Order Trash Pickup	Schedule pickups with interactive map location selection
Multiple Payments	Pay via GCash or Cash on Hand (Xendit integration)
Order History	View past orders and download receipts
Push Notifications	FCM-powered notifications for order updates
Profile Management	Edit profile, change password, manage settings
Collection Schedule	View scheduled garbage collection calendar
Cloud Storage	FileLu integration for file uploads and management

🚛 For Drivers

Feature	Description
Driver Dashboard	View and manage assigned job orders
Interactive Maps	Navigation with collection point locations
Job Status Updates	Update order status (Accept, In-Progress, Complete, Cancelled)
Order History	View completed and cancelled job orders
Profile Management	Manage driver profile and settings
Delivery History	Track all past deliveries and pickups

🛠️ Tech Stack

Core Technologies

Category	Technologies
Language	Kotlin 1.9.x
Min SDK	API 24 (Android 7.0 Nougat)
Target SDK	API 34 (Android 14)
UI Framework	Jetpack Compose + XML Views (Hybrid)
Architecture	MVVM with ViewBinding

Services

Service	Purpose
Firebase Auth	User authentication
Firebase Firestore	Database
Firebase Cloud Messaging	Push notifications
Xendit	Payment processing (GCash)
FileLu API	Cloud file storage

Libraries & Dependencies

Library	Version	Purpose
Jetpack Compose BOM	2024.02.00	Modern UI toolkit
OSMDroid	6.1.16	OpenStreetMap integration
Retrofit	2.9.0	HTTP client
OkHttp	4.9.0	Network layer
Glide	4.16.0	Image loading
Coroutines	1.7.3	Async operations
BCrypt	0.10.2	Password hashing
kizitonwose/Calendar	2.5.1	Calendar view

🚀 Getting Started

Prerequisites

Before you begin, ensure you have the following installed:

Android Studio Hedgehog (2023.1.1) or newer
- Download from developer.android.com
JDK 8 or higher
Git for version control
A physical Android device or emulator (API 24+)

Installation

Clone the repository

git clone https://github.com/MarckRamon/EcoTrack-Mobile.git
cd EcoTrack-Mobile

Open in Android Studio
- Launch Android Studio
- Select File → Open
- Navigate to the cloned directory and select it
- Wait for Gradle sync to complete

Create local.properties (if not exists)

sdk.dir=C:\\Users\\YOUR_USERNAME\\AppData\\Local\\Android\\Sdk

Firebase Setup

Create a Firebase Project
- Go to Firebase Console
- Click "Add project" and follow the wizard
- Enter project name: EcoTrack , GrabTrash, or Similar
Add Android App
- Click "Add app" → Select Android
- Package name: com.example.grabtrash
- App nickname: EcoTrack Mobile
- Register the app
Download Configuration
- Download google-services.json
- Place it in the app/ directory
Enable Firebase Services

In Firebase Console, enable the following:

Service Settings

Authentication Enable Email/Password sign-in

Cloud Firestore Create database in production/test mode

Cloud Messaging Enable for push notifications

Firestore Security Rules (Development)

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    match /{document=**} {
      allow read, write: if request.auth != null;
    }
  }
}

OpenStreetMap Setup

This project uses OpenStreetMap via the OSMDroid library. No API key is required!

Permissions

The following permissions are already configured in AndroidManifest.xml:

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" android:maxSdkVersion="28" />

Configuration

OSMDroid is configured in the app with:
- Tile caching for offline support
- Custom user agent for API compliance
- Location services integration
Usage

The map is used in:
- MapActivity.kt - Location selection for pickups
- DriverMapActivity.kt - Driver navigation
- PrivateEntityMapActivity.kt - Entity location management

💡 Note: OpenStreetMap is free and open-source. No billing setup required!

Build and Run

# Build debug APK
./gradlew assembleDebug

# Install on connected device
./gradlew installDebug

# Or simply click the Run ▶️ button in Android Studio

📂 Project Structure

EcoTrack-Mobile/
├── app/
│   ├── src/main/
│   │   ├── java/com/example/grabtrash/
│   │   │   ├── LoginActivity.kt           # User login
│   │   │   ├── RegisterActivity.kt        # User registration
│   │   │   ├── HomeActivity.kt            # Main home screen
│   │   │   ├── ProfileActivity.kt         # User profile
│   │   │   ├── ScheduleActivity.kt        # Collection schedule
│   │   │   ├── DriverLoginActivity.kt     # Driver authentication
│   │   │   ├── DriverHomeActivity.kt      # Driver dashboard
│   │   │   ├── DriverMapActivity.kt       # Driver navigation
│   │   │   ├── DriverJobOrderActivity.kt  # Job order management
│   │   │   ├── ui/pickup/
│   │   │   │   ├── OrderPickupActivity.kt     # Order creation
│   │   │   │   ├── MapPickerActivity.kt       # Location selection
│   │   │   │   ├── PaymentMethodActivity.kt   # Payment selection
│   │   │   │   ├── OrderSuccessActivity.kt    # Success screen
│   │   │   │   ├── OrderStatusActivity.kt     # Order tracking
│   │   │   │   ├── OrderReceiptActivity.kt    # Receipt display
│   │   │   │   └── model/
│   │   │   │       ├── PickupOrder.kt         # Order data model
│   │   │   │       └── PaymentMethod.kt       # Payment enum
│   │   │   ├── utils/
│   │   │   │   ├── FileLuService.kt           # Cloud storage API
│   │   │   │   └── EcoTrackFirebaseMessagingService.kt
│   │   │   └── models/
│   │   │       └── FileLuModels.kt            # FileLu data models
│   │   └── res/
│   │       ├── layout/           # XML layouts
│   │       ├── drawable/         # Icons, graphics, backgrounds
│   │       ├── values/           # Strings, colors, dimensions
│   │       ├── values-night/     # Dark theme resources
│   │       └── xml/              # Configurations
│   ├── build.gradle.kts          # App-level build config
│   └── google-services.json      # Firebase config (gitignored)
├── gradle/                       # Gradle wrapper
├── build.gradle.kts              # Project-level build config
├── settings.gradle.kts           # Project settings
└── README.md                     # This file

🏗️ App Architecture

The app follows the MVVM (Model-View-ViewModel) architecture pattern:

flowchart TB
    subgraph UI["🖥️ UI Layer"]
        direction LR
        Activities["📱 Activities<br/>(XML)"]
        Fragments["🧩 Fragments<br/>(XML)"]
        Compose["⚡ Jetpack Compose<br/>Screens"]
    end

    subgraph VM["⚙️ ViewModel Layer"]
        ViewModels["ViewModels with LiveData / StateFlow"]
    end

    subgraph Data["💾 Data Layer"]
        direction LR
        Firestore["🔥 Firebase<br/>Firestore"]
        Retrofit["🌐 Retrofit<br/>(REST API)"]
        LocalStorage["📦 Local Storage<br/>SharedPrefs"]
    end

    subgraph External["☁️ External Services"]
        direction LR
        Auth["🔐 Firebase<br/>Auth"]
        FCM["📨 FCM"]
        Xendit["💳 Xendit"]
        OSM["🗺️ OSM"]
        FileLu["📁 FileLu"]
    end

    Activities --> ViewModels
    Fragments --> ViewModels
    Compose --> ViewModels
    ViewModels --> Firestore
    ViewModels --> Retrofit
    ViewModels --> LocalStorage
    Firestore --> Auth
    Firestore --> FCM
    Retrofit --> Xendit
    Retrofit --> FileLu
    LocalStorage --> OSM

Navigation Flow

flowchart TD
    Login["🔐 Login Screen"]
    UserType{"👤 User Type?"}
    
    Login --> UserType
    
    UserType -->|"Regular User"| UserHome["🏠 User Home"]
    UserType -->|"Driver"| DriverHome["🚛 Driver Home"]
    
    subgraph UserFlow["👤 User Flow"]
        UserHome --> OrderPickup["📦 Order Pickup"]
        UserHome --> Schedule["📅 Schedule"]
        UserHome --> Profile["👤 Profile"]
        UserHome --> Notifications["🔔 Notifications"]
        UserHome --> MapPicker["🗺️ Map View"]

        OrderPickup --> Payment["💳 Payment"]
        Payment --> OrderSuccess["✅ Order Success"]
        OrderSuccess --> OrderStatus["📊 Order Status"]
    end
    
    subgraph DriverFlow["🚛 Driver Flow"]
        DriverHome --> AvailableOrders["📋 Available Orders"]
        DriverHome --> DriverMap["🗺️ Driver Map"]
        DriverHome --> CompletedOrders["✅ Completed Orders"]
        DriverHome --> DriverProfile["👤 Driver Profile"]
        
        AvailableOrders --> JobOrder["📝 Job Order Details"]
        JobOrder --> |"Accept"| ActiveJob["🔄 Active Job"]
        ActiveJob --> |"Complete"| CompletedOrders
    end

📖 API Documentation

Internal Documentation

Document	Description
Implementation Manifest	Detailed screen-by-screen implementation guide
FileLu Integration	Cloud storage API integration guide

External Services

Service	Documentation
Firebase	Firebase Android Docs
OpenStreetMap	OSMDroid Wiki
Xendit	Xendit API Docs
FileLu	FileLu API Reference

🧪 Testing

Running Tests

# Run unit tests
./gradlew test

# Run instrumented tests
./gradlew connectedAndroidTest

# Run all tests with coverage
./gradlew testDebugUnitTestCoverage

Test Structure

app/src/
├── test/                    # Unit tests
│   └── java/com/example/grabtrash/
│       └── utils/
│           └── FileLuServiceTest.kt
└── androidTest/             # Instrumented tests
    └── java/com/example/grabtrash/
        └── ExampleInstrumentedTest.kt

🤝 Contributing

We welcome contributions! Please follow these steps:

Getting Started

Fork the repository

Clone your fork

git clone https://github.com/YOUR_USERNAME/EcoTrack-Mobile.git

Create a feature branch
```
git checkout -b feature/amazing-feature
```
Make your changes

Commit with a descriptive message

git commit -m "feat: add amazing feature"

Push to your branch
```
git push origin feature/amazing-feature
```
Open a Pull Request

👥 Team

_{Marck Ramon}
_{Lead Developer}

_{Mykel Seth}
_{Lead Developer}

Contributors

Thanks to everyone who has contributed to this project!

📄 License

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

MIT License

Copyright (c) 2024 GrabTrash Team

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

🙏 Acknowledgments

Firebase for backend services
OpenStreetMap for free and open map data
OSMDroid for the Android map library
Xendit for payment processing
FileLu for cloud storage
All the amazing open-source libraries that made this project possible

GrabTrash Mobile
Made with 💚 for a cleaner environment

⭐ Star us on GitHub if this project helped you!

Name		Name	Last commit message	Last commit date
Latest commit History 81 Commits
.idea		.idea
.kotlin/errors		.kotlin/errors
.vscode		.vscode
app		app
gradle		gradle
.gitignore		.gitignore
FileLu_Integration_README.md		FileLu_Integration_README.md
README.md		README.md
TruckAdapter.kt.unused		TruckAdapter.kt.unused
TruckSelectionDialog.kt.unused		TruckSelectionDialog.kt.unused
build.gradle.kts		build.gradle.kts
dialog_truck_selection.xml.unused		dialog_truck_selection.xml.unused
gradle.properties		gradle.properties
gradlew		gradlew
gradlew.bat		gradlew.bat
implementation_manifest.md		implementation_manifest.md
item_truck.xml.unused		item_truck.xml.unused
settings.gradle.kts		settings.gradle.kts

Service	Settings
Authentication	Enable Email/Password sign-in
Cloud Firestore	Create database in production/test mode
Cloud Messaging	Enable for push notifications

Folders and files

Latest commit

History

Repository files navigation

🌿 GrabTrash Mobile

📑 Table of Contents

✨ Features

👤 For Users

🚛 For Drivers

🛠️ Tech Stack

Core Technologies

Services

Libraries & Dependencies

🚀 Getting Started

Prerequisites

Installation

Firebase Setup

OpenStreetMap Setup

Build and Run

📂 Project Structure

🏗️ App Architecture

Navigation Flow

📖 API Documentation

Internal Documentation

External Services

🧪 Testing

Running Tests

Test Structure

🤝 Contributing

Getting Started

👥 Team

Contributors

📄 License

🙏 Acknowledgments

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors

Uh oh!

Languages

Packages