Git Product home page Git Product logo

quran's Introduction

Quran Flutter

Quran made with Flutter

If you want to contribute, fill it up and then refer to Trello board for planning and task list.

Why this project is important?

Ayat is a Quran project from King Saud University, it has the following platforms: iOS, Android, Mac, Windows, Web, Linux. so users have a similar experience on all the platforms, but unfortunately, this project is deprecated.

The reason that is important

  1. Those who memorize Quran wants to have similar actual Mushaf experience, as an example Quran for Android or Quran for iOS have different highly modified Quran image than actual Madina mushaf which is crucial for a memorizer to have similar look and feel for visual memorization purpose, or other alternatives aren't available across the platforms.
  2. A person might want to switch platforms and revise their Quran reading on another platform.
  3. All the current projects are different in their own ways and have different codebase thus keep maintaining and adding new features is difficult.
  4. After deprecating of Ayat there is no similar solution that works well on all the platforms with similar experience.

My proposal: Develop a Quran project with Flutter, with Flutter it is possible to have a single codebase for all the platforms with similar experience while having single Codebase will make it easier to maintain and keep developing. I'm looking for more contributors.

Contribution Guide lines

  • Go to Trello board and have a look on tasks list
  • Assign youself a task that you think are appropiate to do
  • Clone this repo and create branch from dev branch and branch name should be same as task name/ID
  • After completing task create pull request to merge with dev branch.

Coding guide lines

  • This project uses Flutter Bloc as state management, every single feature must follow this state managemnt.
  • SOLID principals must not be broken.
  • For project and coding structure, styles first go through this repo's codes first, your coding styles and structure has to be matched with this project's coding styles and structures.
  • Any kind of anti-patterns must not be implemented or design pattern must not be broken.

quran's People

Contributors

sadmansamee avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.