Skip to main content
Nimaz is a modern Islamic companion app built entirely with Android’s latest development tools and best practices. This documentation will help you understand the codebase and start contributing.

​
Tech stack

Nimaz is built with a modern Android development stack focused on Kotlin and Jetpack libraries:

Jetpack Compose

Modern declarative UI toolkit for building native Android interfaces

Hilt

Dependency injection framework built on top of Dagger

Room

SQLite abstraction layer for robust local data persistence

Kotlin Coroutines

Asynchronous programming with Flow for reactive data streams

​
Project configuration

android {
    namespace = "com.arshadshah.nimaz"
    compileSdk = 36
    
    defaultConfig {
        applicationId = "com.arshadshah.nimaz"
        minSdk = 29
        targetSdk = 36
        versionCode = 300
        versionName = "3.0.0"
    }
    
    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_21
        targetCompatibility = JavaVersion.VERSION_21
    }
}

​
Architecture principles

Nimaz follows Clean Architecture principles with clear separation of concerns:
  • Domain Layer: Business logic and use cases
  • Data Layer: Repository implementations and data sources
  • Presentation Layer: UI components and ViewModels
The app uses unidirectional data flow (UDF) pattern with ViewModels emitting UI state via StateFlow.

​
Development setup

​
Prerequisites

  • Android Studio Hedgehog (2023.1.1) or later
  • JDK 21
  • Android SDK 36
  • Kotlin 2.3.0 or later

​
Building the project

  1. Clone the repository
  2. Open the project in Android Studio
  3. Sync Gradle dependencies
  4. Run the app on an emulator or physical device (API 29+)
./gradlew assembleDebug

​
Key features

Nimaz includes comprehensive Islamic features:
  • Complete Quran with multiple translations
  • Tafseer (commentary) with highlighting and notes
  • Bookmarks, favorites, and reading progress tracking
  • Khatam (recitation completion) tracking with daily goals
  • Accurate prayer times using the Adhan library
  • Prayer tracking with historical records
  • Customizable notifications with Adhan sounds
  • Qibla compass with camera overlay
  • Hadith collections from various books
  • Dua (supplications) with audio playback
  • 99 Names of Allah (Asma ul Husna)
  • Names of Prophet Muhammad (Asma un Nabi)
  • Stories of 25 Prophets
  • Digital Tasbih (counter) with presets
  • Fasting tracker for Ramadan and voluntary fasts
  • Zakat calculator with history
  • Hijri calendar with Islamic events
  • Next prayer time widget
  • All prayer times widget
  • Prayer tracker widget
  • Hijri date widget
  • Hijri calendar widget

​
Testing

Nimaz uses a comprehensive testing setup:
  • Unit Tests: JUnit, MockK, Truth, Turbine, Robolectric
  • Instrumented Tests: Espresso, Compose UI Testing, Hilt Testing
# Run unit tests
./gradlew test

# Run instrumented tests
./gradlew connectedAndroidTest

​
Contributing

When contributing to Nimaz:
  1. Follow the existing architecture patterns
  2. Use meaningful commit messages
  3. Write tests for new features
  4. Follow Kotlin coding conventions
  5. Update documentation as needed
Make sure to test on devices running Android 10 (API 29) and above, as this is the minimum supported version.

​
Next steps

Architecture

Learn about the Clean Architecture implementation

Project structure

Understand the directory organization

Dependencies

Explore the key libraries and their usage

Build docs developers (and LLMs) love

Get started for freeTalk to us