README.md

Azan

'Minimal Adhan' is now 'Azan'

An Open-Sourced Adhan app for the ummah.

Built With FLutter

---

Features

• Zero Data Collection Without users concern

• Multiple language support
  • English
  • Arabic
  • Bangla
  • Your contribution ❤️
• Adhan Timings:
  • 5 Prayer Times
  • Sunrise Time
  • Midnight Time (For Qiam-ul-layl)
  • Last Third of night Time (For Qiam-ul-layl)
• Qibla Direction and compass
• Essential Duas with translations and transliteration in multiple languages
• Tasbih
• Mosque Finder
• Able to configure adhan time calculation parameters
  • Calculation methods
  • Madhab (School of thoughts)
  • High Latitude rules
  • Adhan Visibility
  • Manual Corrections
  • See More
• Adhan Notification
  • On Time Notification
  • Persistent Notification

---

Development

• Dependencies:
  • adhan
  • geolocator
  • intl
  • auto_size_text
  • webview_flutter
  • provider
  • hijri
  • geocoding
  • shared_preferences
  • flutter_compass
  • flutter_svg
  • lottie
  • sqflite
  • scrollable_positioned_list
  • package_info_plus
  • android_alarm_manager_plus
  • flutter_local_notifications

---

Contribute to this project?

---

Contributions

Contribute to this project?

Translating the app

1. Create an app_<lang_code>.arb (e.g. app_ar.arb) file in minimal_adhan/locales/langs
2. Copy contents of minimal_adhan/locales/langs/app_lang_template.arb to the newly created file.
3. Fill up the translations. You can find both description and english keyword/sentence in the description param of the keys. e.g: From:

{
  "@__________________________________________Global_Page": {
  },
  "locale": "",
  "@locale": {
    "description": "Name of Locale.",
    "eg_english": "en"
  },
  "direction": "",
  "@direction": {
    "description": "Language direction - Either Left-To-Right (ltr) or Right-To-left(rtl).",
    "eg_english": "ltr"
  },
  "current_lang": "",
  "@current_lang": {
    "description": "Name of this language in its language",
    "eg_english": "English"
  },

To:

{
  "@__________________________________________Global_Page": {
  },
  "locale": "ar",
  "@locale": {
    "description": "Name of Locale.",
    "eg_english": "en"
  },
  "direction": "rlt",
  "@direction": {
    "description": "Language direction - Either Left-To-Right (ltr) or Right-To-left(rtl).",
    "eg_english": "ltr"
  },
  "current_lang": "العربية",
  "@current_lang": {
    "description": "Name of this language in its language",
    "eg_english": "English"
  },
  "one": "١",
  "@one": {
    "description": "Translation of the digit 1",
    "eg_english": "1"
  },

4. Create an app_<lang_code>.dart (keep the name same as the .arb file).
5. import 'package:minimal_adhan/models/app_local.dart';
6. Create a new class here named Locale<LanguageName> (e.g. LocaleArabic) and extend the AppLocale class:

class LocaleArabic extends AppLocale{
}

7. Create a const constructor and pass the language code to the super block: const LocaleArabic(): super('ar');
8. Ovveride getter languageName :

  @override
  String get languageName => '(Beta) عربى';

9. Ovveride getter duaElementsAvailable (This tells the app if there is dua translations/transliterations available for this language):

  @override
  bool get duaElementsAvailable => false;

10. Ovveride the getter fontFamily (This is nullable and only return value if font is added to this app (see 'Add Custom Fonts' section ). otherwise, return null):

  @override
  String? get fontFamily => 'lateef';

11. Ovveride the function TextTheme getTextTheme(BuildContext context) and return a textTheme(it can be a default one i.e. Theme.of(context).textTheme or a modified one.):

@override
  TextTheme getTextTheme(BuildContext context){
    return context.textTheme
        .copyWith(
      headline1: context.textTheme.headline1?.copyWith(height: 1.0),
      headline5: context.textTheme.headline5?.copyWith(
        height: 1.0,
      ),
      headline6: context.textTheme.headline6?.copyWith(
        height: 1.5,
      ),
    )
        .apply(
      fontFamily: fontFamily,
    );
  }

Translations

• Arabic - Musaab Brother
• Bangla - Rhyme Rubayet

Icons

Mosque icons created by Freepik - Flaticon

• Islam icons created by Freepik - Flaticon
• Mosque icons created by Freepik - Flaticon
• Compass icons created by Freepik - Flaticon
• Tasbih icons created by Freepik - Flaticon
• Quran icons created by kmg design - Flaticon
• Dua icons created by shmai - Flaticon
• Settings icons created by Freepik - Flaticon
• Quran icons created by Andrean Prabowo - Flaticon
• Gps icons created by adrianadam - Flaticon
• Warning icons created by Freepik - Flaticon
• Random icons created by Bamicon - Flaticon
• Mosque icons created by Freepik - Flaticon
• Fajr icons created by Freepik - Flaticon
• Cultures icons created by Freepik - Flaticon
• Asr icons created by Freepik - Flaticon
• Maghrib icons created by Freepik - Flaticon
• Isha icons created by Freepik - Flaticon
• Sunrise icons created by Slidicon - Flaticon
• Nearby icons created by Fuzzee - Flaticon

---

Lisence

GNU GPL V3

Full readme would be available as soon as the project hits stable stage.