alquran_cloud

Paketübersicht

Aus öffentlichen Paketdaten erstellte Orientierung.

Das alquran_cloud-Paket ist eine nicht-offizielle Dart-Client-Wrapping für die quran.cloud-API, die Entwicklern ermöglicht, den heiligen Koran in verschiedenen Formaten einfach abzurufen und zu nutzen. Es bietet eine saubere, intuitive Schnittstelle zum Abrufen von Koranversen, Kapiteln, Übersetzungen und Tafsir (Auslegung). Für den plattformübergreifenden Einsatz konzipiert, unterstützt es Android, iOS, Web, macOS, Windows und Linux. Das Paket vereinfacht die Integration in Flutter-Apps, die koranische Inhalte benötigen, und ist daher ideal für religiöse, pädagogische oder devotiv orientierte Anwendungen.

Anwendungsfälle

Integration von koranischen Texten in Mobile Apps
Anzeige von Übersetzungen und Tafsir
Quran-Leseverfahren und Lernwerkzeuge erstellen
Multisprachige islamische Bildungs-Apps erstellen
Offline-Zugriff auf die Quran mit Caching aktivieren

Hauptmerkmale

Einfache API zum Abrufen von Quran-Daten
Unterstützt mehrere Übersetzungen und Vorträge
Plattformübergreifende Kompatibilität
Eingebaute Fehlerbehandlung
Leicht und einfach zu integrieren

Geeignet für

Flutter-Entwickler, die islamische Apps erstellen
Ersteller von Bildungs-Apps
Religiöse Inhaltsplattformen
Apps, die genaue koranische Zitate erfordern
Entwickler, die die quran.cloud-API verwenden

Hinweise

Benötigt Internetverbindung für Echtzeitdaten
Beschränkt auf Funktionen, die von der quran.cloud-API bereitgestellt werden
Keine offizielle Zustimmung von Quran.cloud
Möglicherweise benötigt man zusätzliche Logik für Offline-Funktionalität
Abhängig von der Stabilität der externen API

Original-README

Originaler README-Schnappschuss aus dem verknüpften Quell-Repository. Aktuelle Inhalte finden Sie im Repository.

Alquran Cloud

unofficial api wrapper for the free islamic api alquran.cloud usage

void main(List<String> args) async {
  /// to enable logs (disabled by default)
  quran_cloud.quranCloud.enableLogs = true;

  /// use edition identifer to determine which edition of the quran to get
  final allEditions = await quran_cloud.getAllEditions();

  /// also you can query the edition you want
  final editionsQuery = await quran_cloud.getAllEditions(
    format: 'text', // or `audio`
    language: 'ar', // use .getEditionSupportedLanguages(); to get the all available languages
    type: 'quran', // user .getEditionTypes() to get all available types
  );

  final quran = await quran_cloud.getQuranByEdition(allEditions.first);

  /// get surah by number and edition
  final surah = await quran_cloud.getSurahByEdition(1, editionsQuery.first);

  /// get aya by number and edition
  final aya = await quran_cloud.getAyaByNumber(2, editionsQuery.first);

  print(aya.text); // الْحَمْدُ لِلَّهِ رَبِّ الْعَالَمِينَ

Endpoints

[x] Editions
[x] Quran
[x] Juz
[x] Surah
[x] Aya
[ ] Manzil
[ ] Ruku
[ ] Page
[ ] Hizb
[ ] Quarter
[ ] Sajda
[ ] Meta
[x] CDM (audio/image)

Features

[ ] cache (awaiting this PR https://github.com/hurshi/dio-http-cache/pull/84)
[ ] prayer times
[ ] docs
[ ] re-tray

Pakete, Repositories und App-Kategorien suchen

Paket installieren