Localization Guide – How to Localize Muajjin Into Your Language

📚 Introduction

Welcome to the Muajjin localization guide! Muajjin is a prayer times application that supports community-driven localization. This guide explains how to create a localization file for your language.

✨ Features

• Fully Localizable: Every user-facing string in the app can be localized
• RTL Support: Full right-to-left support for Arabic, Urdu, Hebrew, etc.
• Offline Ready: Localization files work fully offline once imported
• Easy Import: Just import a JSON file and your localization is ready

🎯 Localization Requirements

• JSON Format: Localization files must be valid JSON
• Metadata: Include language name, language code, direction, and version
• Complete Localization: Localize all values (keys must remain in English)

📋 Step-by-Step Guide

Step 1: Download the Template

The English base template is provided below in a code block. Copy it into a file named:

muajjin-[language-code].json

Step 2: Localize All Values

• Keep all keys in English (example: "common.save")
• Only localize the values (example: "Save" → "حفظ")
• Do not change the structure or nesting
• Localize everything for a complete experience

Step 3: Set Language Direction

For left-to-right (LTR) languages (English, French, etc.):

"direction": "ltr"

For right-to-left (RTL) languages (Arabic, Urdu, Hebrew, Farsi, etc.):

"direction": "rtl"

Step 4: Import Your Localization

• Open the Muajjin app
• Go to Settings → Localization
• Click Import File
• Select your JSON file
• Your localization is applied instantly

🔧 Important Notes

Placeholders

Some strings include placeholders such as {{city}}, {{country}}, or {{minutes}}.
These placeholders must remain exactly the same in your localized text.

Example:

"locationDetected": "Location detected: {{city}}, {{country}}"

Arabic example:

"locationDetected": "تم تحديد الموقع: {{city}}، {{country}}"

📱 Testing Your Localization

• Import your localization file
• Check all pages (Home, Settings, Onboarding)
• Verify text direction (LTR or RTL)
• Test with different prayer times
• Ensure no English text remains
• Fix any layout or wording issues

🌐 Sharing Your Localization

Once your localization is complete and tested:

• Create a new post in the Localization category
• Include the language name, your name (optional), and any notes
• Attach the JSON file or paste it inside a code block
• Others can import and use your localization

❓ Questions?

If you have any questions about localization, feel free to ask in this discussion.

---

📄 Complete Localization Template (English)

Download this JSON file and localize it into your language.

---

🌟 Happy Localizing!

We appreciate your contribution to making Muajjin accessible to Muslims around the world in their own language and regional context.