radensaleh/Quran-App

🕌 Quran App is a Flutter application built to demonstrate the use of modern development tools with best practices implementation like Modularization, BLoC, Dependency Injection, Dio, Audio, Sqlite, Shared Preferences etc.

Quran App

Features

• Show All Surah
• Last Read Surah
• Detail Surah & Verses
• Bookmark Verses
• Play Audio Verses
• Dark Theme Mode

Banner Design

Quick start

This is a normal flutter app. You should follow the instructions in the official documentation. This project uses BLoC (business logic component) to separate the business logic with UI itself. It's recommended to do self-study about it before jumping into the project here. And also on this project uses Modularization approach to separate each feature (domains, features, resources, shared_libraries modules).

Modularization Structure 🔥

# Root Project
.
├── domains                # Name of directory
|   ├── domain A           # Domains module with a data and domains layer inside it.
|   ├── domain B
|   └── domain etc
|
├── features               # Name of directory
|   ├── feature A          # Feature module with a presentation/ui/feature layer inside it.
|   ├── feature B
|   └── feature etc
|
├── lib                    # Name of module (default from Flutter)
|
└── resources              # Name of directory
|       └── resources      # Handle resources like style, fonts, constant value, etc.
|
└── shared_libraries       # Name of directory
    ├── common             # Handle common utility class.
    ├── core               # Core module.
    └── dependencies       # Handle dependency version updates.

Resources 🔥

• Sample Demo
• API Source
• Design Reference

Built With 🛠

• Modularization - Separate functionality into independent, interchangeable modules.
• Clean Architecture - The blueprint for a modular system, which strictly follows the design principle called separation of concerns.
• Dependency Injection (get_it) - Simple direct Service Locator that allows to decouple the interface from a concrete implementation and to access the concrete implementation from everywhere in your App.
• BLoC Pattern - Business logic component to separate the business logic with UI.
• SQLite - Local Database
• Equatable - Being able to compare objects in Dart often involves having to override the == operator.
• Dio - A type-safe HTTP client.
• Shared Preferences - Cache implementation approach.
• Provider - A wrapper around InheritedWidget to make them easier to use and more reusable.
• Flash - A highly customizable, powerful and easy-to-use alerting library.
• Just Audio - A feature-rich audio player for Flutter.
• Handle State - (Loading, No Data, Has Data, Error)

Author

• Raden Saleh

Don't forget to follow me, fork and give me a ⭐

License

MIT License

Copyright (c) 2022 Raden Saleh

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.