-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ca6cd89
commit d4b1508
Showing
1 changed file
with
76 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,16 +1,82 @@ | ||
| # suji | ||
|
|
||
| A new Flutter project. | ||
|  | ||
| <p align="center"> | ||
| <img src="https://img.shields.io/badge/dart-%230175C2.svg?style=for-the-badge&logo=dart&logoColor=white" /> | ||
| <img src="https://img.shields.io/badge/Flutter-%2302569B.svg?style=for-the-badge&logo=Flutter&logoColor=white" /> | ||
| <img src="https://img.shields.io/badge/git-%23F05033.svg?style=for-the-badge&logo=git&logoColor=white" /> | ||
| <img src="https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white" /> | ||
|
|
||
| </p> | ||
| <p align="center"> | ||
| Suji is a Muslim application for reading the Quran and prayer reminders. | ||
| <br /> | ||
| <a href="https://github.com/phanatagama/Suji/releases/download/v.1.0.0/app-debug.apk">Download App</a> | ||
| · | ||
| <a href="https://github.com/phanatagama/Suji/issues/new">Report Bug</a> | ||
| · | ||
| <a href="https://github.com/phanatagama/Suji/issues/new">Request Features</a> | ||
| </p> | ||
|
|
||
| ## 💡 Background | ||
| The background of this project focusing on Quran recitation, Quran audio playback, and prayer schedule reminders reflects a very meaningful effort in bringing technology in support of Muslims' religious practices and spirituality. The project aims to provide easy and practical access for Muslims to connect with the sacred text of the Quran and perform prayers on time. | ||
|
|
||
| In the ever-evolving digital age, technologies such as Android apps have opened up new opportunities to enhance religious experiences. The Suji app attempts to combine traditional values with the ease of accessibility offered by technology. | ||
|
|
||
| It is important to mention that this project can also help users in understanding and following the prayer schedule, which is often a mandatory part of Muslims' daily lives. By using the Suji app, users can focus more on their religious practices without worrying about missing prayer times. | ||
|
|
||
| We wish your project success in benefiting the Muslim community and making it easier for them to worship and connect with the Quran. | ||
|
|
||
| ## ♻️ Project Goals | ||
| This application is made to facilitate Muslim brothers who want to recite the Quran through smartphone devices and create prayer schedule reminders. | ||
|
|
||
| ## 🤯 Challenges we faced | ||
| it's been quite a while since I last worked with flutter about 1 year ago. I'm trying to learn again good app development with the flutter framework and integration of some libraries and good documentation. Fetching data from different api sources and caching is quite challenging for me. | ||
|
|
||
| ## 🧐 How we built our project | ||
| This project is built with Getx as state management and data derived from [Quran API](https://api.quran.gading.dev) and [Prayer Schedule API](https://aladhan.com). A caching method with IsarDB is applied to reduce the load of requests to the API. I used alarm_manager_plus and flutter_local_notification libraries for the prayer schedule reminder feature. | ||
|
|
||
| ## 🛠️ Tech Stack Used | ||
| | Dart | Flutter | | ||
| |------------|-------------| | ||
| | <img src="https://avatars.githubusercontent.com/u/1609975?s=280&v=4" width="150"> | <img src="https://res.cloudinary.com/startup-grind/image/upload/c_fill,dpr_2.0,f_auto,g_center,h_500,q_auto:good,w_500/v1/gcs/platform-data-dsc/events/1_ilC2Aqp5sZd1wi0CopD1Hw_zT8WoJh.png" width="150"> | | ||
|
|
||
| <!-- ### Extra Library --> | ||
| <!-- - [GoogleFonts](https://pub.dev/packages/google_fonts) for Material-Design style --> | ||
|
|
||
|
|
||
| <!-- ## 🔧 The problems and how we deal with it --> | ||
| <!-- Tentu saja keterbatasan waktu adalah sebuah masalah bagi kami. Beberapa perencanaan harus kami tunda/hilangkan untuk mempersingkat waktu seperti pembangunan [REST API](https://github.com/MochArisandiJayanto/Flarax/blob/master/API_Design_Architecture.md) yang harus terhenti. Kami memutuskan untuk melakukan query secara langsung dengan database Firebase menggunakan future dan stream. --> | ||
|
|
||
| ## 🧑🎓 What we learned | ||
| From this project I learnt how to cache data from api sources and do scheduled notifications on background services. I also tried to understand the use of Hive as a key-value pair based storage and IsarDB as a NoSQL database. | ||
|
|
||
| ## 🐾 Conventional Commit | ||
| In this project, I endeavoured to follow the [commit convention](https://www.conventionalcommits.org/en/v1.0.0/) so that the commit messages are cleaner and more readable. I think it's awesome and makes it practically easy for me to be able to backtrack through each commit deployment. | ||
|
|
||
| <!-- ## 📘 Resource --> | ||
| <!-- ### Image Assets --> | ||
| <!-- - [Undraw](http://undraw.co) --> | ||
| <!-- - [Unsplash](http://unsplash.com) --> | ||
|
|
||
| <!-- ### Related Article --> | ||
| <!-- - [Barang Menumpuk Tak Terpakai? Akali Dengan 5 Trik Ini | Orami](https://www.orami.co.id/magazine/barang-menumpuk-tak-terpakai-akali-dengan-5-trik-ini/) --> | ||
| <!-- - [Bagaimana cara membuang barang bekas berukuran besar, misal kasur, kulkas, mesin cuci? Kemana perabot/barang bekasmu saat kamu membeli perabot baru? - Quora](https://id.quora.com/Bagaimana-cara-membuang-barang-bekas-berukuran-besar-misal-kasur-kulkas-mesin-cuci-Kemana-perabot-barang-bekasmu-saat-kamu-membeli-perabot-baru) --> | ||
| <!-- - [Bagaimana caramu membuang barang-barang yang sudah tidak terpakai lagi (misalnya pakaian bekas yang sudah tidak layak pakai)? - Quora](https://id.quora.com/Bagaimana-caramu-membuang-barang-barang-yang-sudah-tidak-terpakai-lagi-misalnya-pakaian-bekas-yang-sudah-tidak-layak-pakai) --> | ||
| <!-- - [Bagaimana cara membuang sampah ukuran besar seperti kasur dan lemari secara legal? - Quora](https://bit.ly/3eoe6rK) --> | ||
| <!-- - [Cara Mendapatkan Barang Gratis Dari Internet - Blog Orang IT (helmykediri.com)](https://bit.ly/3FuCeVn) --> | ||
| <!-- - [Barang Gratis Bisa Kamu Dapatkan di 6 Situs Ini Lho! (lifepal.co.id)](https://lifepal.co.id/media/doyan-berburu-barang-gratisan-cek-6-situs-nih/) --> | ||
|
|
||
| ## 👁️ Preview/Screenshots | ||
|
|
||
| |  |  |  |  | | ||
| | :--: | :--: | :--: | :--: | | ||
| | **Home Page** | **Search Page** | **Surah/Ayat** | **Prayer Time** | | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Getting Started | ||
|
|
||
| This project is a starting point for a Flutter application. | ||
|
|
||
| A few resources to get you started if this is your first Flutter project: | ||
|
|
||
| - [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab) | ||
| - [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook) | ||
|
|
||
| For help getting started with Flutter development, view the | ||
| [online documentation](https://docs.flutter.dev/), which offers tutorials, | ||
| samples, guidance on mobile development, and a full API reference. |