{"id":15296304,"url":"https://github.com/islamic-network/alquran-tools","last_synced_at":"2025-04-07T06:05:39.189Z","repository":{"id":55927210,"uuid":"96684721","full_name":"islamic-network/alquran-tools","owner":"islamic-network","description":"Various tools for Parsing Quran Tajweed, Buck, etc.","archived":false,"fork":false,"pushed_at":"2023-05-19T06:30:24.000Z","size":54,"stargazers_count":128,"open_issues_count":2,"forks_count":31,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-31T05:03:12.148Z","etag":null,"topics":["buckwalter-transliteration","islam","php","php7","quran","quran-api"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/islamic-network.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-07-09T13:03:52.000Z","updated_at":"2025-03-25T00:59:15.000Z","dependencies_parsed_at":"2024-10-15T01:21:44.696Z","dependency_job_id":"0ac7434a-397b-472b-b534-82553a3ca3fc","html_url":"https://github.com/islamic-network/alquran-tools","commit_stats":{"total_commits":30,"total_committers":5,"mean_commits":6.0,"dds":0.1333333333333333,"last_synced_commit":"5e8a1242807f53ff1557996efc19e25f587786e1"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/islamic-network%2Falquran-tools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/islamic-network%2Falquran-tools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/islamic-network%2Falquran-tools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/islamic-network%2Falquran-tools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/islamic-network","download_url":"https://codeload.github.com/islamic-network/alquran-tools/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247601447,"owners_count":20964864,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["buckwalter-transliteration","islam","php","php7","quran","quran-api"],"created_at":"2024-09-30T18:10:00.846Z","updated_at":"2025-04-07T06:05:39.170Z","avatar_url":"https://github.com/islamic-network.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"## بِسْمِ اللهِ الرَّحْمٰنِ الرَّحِيْمِ\n\n![](https://img.shields.io/packagist/dt/alquran/tools.svg)\n[![](https://img.shields.io/github/license/islamic-network/alquran-tools.svg)](https://github.com/islamic-network/alquran-tools/blob/master/LICENSE)\n\n# Quran Tools for Parsing Tajweed and Buck\nThese *PHP* tools are to be used with the \u003ca href=\"https://alquran.cloud/api\"\u003eAlQuran.cloud\u003c/a\u003e and \u003ca href=\"http://docs.globalquran.com/API:Data/Quran_List\"\u003eGlobalQuran.com\u003c/a\u003e APIs. They are made available so you may get the most out of the APIs.\n\nThere's a React equivalent of this package @ https://github.com/aamirbhat382/Tajweed.\n\n# What do they contain\nFor now, a \u003ca href=\"docs/tajweed.md\"\u003eTajweed\u003c/a\u003e and \u003ca href=\"docs/buck.md\"\u003eBuck\u003c/a\u003e helper. Each section is detailed below. \n\n# Install and Get Started\nThe tools add developer libraries you can use in your application. Install using composer:\n```\ncomposer require alquran/tools\n```\n\n### Tajweed Example\nTo get tajweed text to become legible, use:\n```php\n\u003c?php\nrequire_once('vendor/autoload.php');\n\n$parser = new \\AlQuranCloud\\Tools\\Parser\\Tajweed();\n$html = $parser-\u003eparse($text); // $text is the output text of a Verse from quran-tajweed edition. For example: http://api.alquran.cloud/ayah/24:35/quran-tajweed. Also see data/tajweed.json.\n```\n\n### Buckwalter Transliteration example\nTo get tajweed text to become legible, use:\n```php\n\u003c?php\nrequire_once('vendor/autoload.php');\n\n$parser = new \\AlQuranCloud\\Tools\\Parser\\Buck();\n$arabic = $parser-\u003etoArabic($text); // $text is the output text of a Verse from quran-buck edition. For example: http://api.alquran.cloud/ayah/24:35/quran-buck.\n```\n\n## Tajweed Documentation\n\nSee \u003ca href=\"docs/tajweed.md\"\u003eTajweed Documentation\u003c/a\u003e.\n\n## Buck (Buckwalter Transliteration) Documentation\n\nSee \u003ca href=\"docs/buck.md\"\u003eBuck Documentation\u003c/a\u003e.\n\n## Are there any known Issues\n~~Yes, with the Tajweed parser. Webkit has a known bug that breaks Arabic with inline tags. There is an experimental fix in the Tajweed Parse class for this using the Zero Width Joiner (\u0026zwj;), but it still needs some work. I've manually tried this on some Ayahs and ZWJ is not smart enough to parse all the characters and join them properly, so this is not ideal. See See https://stackoverflow.com/questions/11155849/partially-colored-arabic-word-in-html\nand https://bugs.webkit.org/show_bug.cgi?id=6148.~~ The issue with parsing in Chrome seems to have been resolved with Chrome's new layout implementation (https://www.chromium.org/blink/layoutng). It has been tested on version 77.0.3865.90.\n\n## Credits\nMost of this code is created using logic from the Global Quran website and codebase.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fislamic-network%2Falquran-tools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fislamic-network%2Falquran-tools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fislamic-network%2Falquran-tools/lists"}