MatatuGo

MatatuGo is an Android mobile application designed to enhance the experience of using Matatus in Kenya. The app provides users with route planning, navigation, and relevant transport information to make commuting easier and more efficient.

Table of Contents

• Project Overview
• Key Features
• Architecture
• Key Code and Components
• Dependencies
• Coroutines Usage
• Getting Started
• Build and Run
• Authors
• Screenshots

---

Project Overview

MatatuGo is built using Kotlin and follows modern Android development practices. The project leverages Android Jetpack components, MVVM architecture, and uses coroutines for asynchronous operations.

Key Features

• Matatu information
• Route planning and navigation
• User-friendly interface
• Integration with Android location services

Architecture

• Language: Kotlin
• Architecture Pattern: MVVM (Model-View-ViewModel)
• UI: Android XML layouts
• Asynchronous Operations: Kotlin Coroutines
• Dependency Management: Gradle

Key Code and Components

• app/src/main/java/: Contains all the source code for activities, view models, repositories, and utilities.
• app/src/main/res/: Contains resources such as layouts, drawables, and values.
• app/src/main/AndroidManifest.xml: App manifest file.
• build.gradle.kts: Project and app-level Gradle build scripts.

Dependencies

The project uses several key dependencies (see build.gradle.kts for the full list):

• AndroidX libraries (AppCompat, Lifecycle, Navigation)
• Kotlin Standard Library
• Material Components
• Retrofit, Room, and other Jetpack libraries
• Coroutine libraries for async operations

Coroutines Usage

What is a Coroutine? A coroutine is a concurrency design pattern in Kotlin that allows you to write asynchronous code in a sequential manner. Coroutines help manage background tasks such as network requests or database operations without blocking the main thread.

Are Coroutines Used in This Project? Yes. Coroutines are used for background operations.

Getting Started

1. Clone the repository:

   git clone <repository-url>
   

2. Open in Android Studio.
3. Sync Gradle and build the project.
4. Run the app on an emulator or physical device.

Build and Run

• Use the provided gradlew or gradlew.bat scripts to build the project:

  ./gradlew assembleDebug
  

• To install and run on a connected device:

  ./gradlew installDebug
  

Authors

• Dennis Mukoma
• Kristina Kemoi
• Janny Jonyo
• Cindy Ogutu

Screenshots

• Splash Screen

• Home Page

• Picking the best Route

• Navigating to the Desired Location

• No Route Found

• Profile Page

• App Icon