Muajjin

Open source, privacy-focused, offline-first Salat & Saum times companion.

---

Overview

Muajjin is a lightweight, privacy-friendly Islamic Salat & Saum times app built with modern web technologies and packaged as a native Android application using Capacitor.

Times are calculated locally on the device—no tracking, no remote APIs required.

Philosophy

This app is designed with a minimal feature philosophy. The focus is intentionally narrow:

• ✅ Salat times
• ✅ Saum times (Suhoor/Iftar)

Any additional features beyond these core functions will not be implemented. The goal is to keep the app simple, lightweight, and focused on its essential purpose.

---

Features

• 🕌 Accurate Salat time calculation based on location
• 📍 Automatic GPS location with IP-based fallback
• ⏰ Current Salat highlighting and next Salat countdown
• 🌙 Suhoor and Iftar times for Saum
• 📅 Hijri date display
• 🎨 Automatic light and dark theme support
• 📱 Native Android app via Capacitor

---

Getting Started

Install Dependencies

bun install

Development

bun run dev

Production Build

bun run build

---

Android Build

Signing & APK Build

Keystore Setup

1. Place your keystore file in:

android/app/

2. Create or edit android/local.properties:

keystore.file=app/your-keystore.keystore
keystore.password=your_password
keystore.key.alias=your_alias
keystore.key.password=your_key_password

Build APK

# Debug APK (larger, faster build)
bun run android:build

# Release APK (optimized, smaller)
bun run android:release

# GitHub Release APK (includes in-app update checker)
bun run android:release:github

APK Output Directory

android/app/build/outputs/apk/

Build Modes (Update Checker)

• Default builds (web/Play/F-Droid): no GitHub update checker is bundled. Use:
  • bun run build (web bundle)
  • bun run android:build or bun run android:release
• GitHub release builds (include update checker + dialog):
  • bun run android:build:github
  • bun run android:release:github

---

Contributing

Contributions are welcome! However, please note that this project follows a minimal feature philosophy.

Before proposing or implementing any new features, please open a discussion first to talk about it. Features that fall outside the core scope (Salat times and Saum times) will not be accepted.

Bug fixes, performance improvements, and localization/translation contributions are always appreciated.

---

License

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