QuranFlow Admin · onboarding
Assalamu alaikum 🌙
We are excited to have you on this project. This is the production rebuild of the QuranFlow Admin — the tool our team uses every day to teach Quran to thousands of students.
Below are five short docs that take you from "just cloned the repo" to "ready to build features." Read them in order. Most people finish in about an hour.
Any questions? Just open a GitHub issue and tag @Kamran-AM — I'll get back to you the same day.
Read these 5 in order
Start here. A short summary of the whole project.
A visual tour. The fastest way to understand how everything fits together.
Every library and tool we picked, and the reason for each choice.
The project map. Where every doc lives and what it covers.
How we write code in this repo. Read this before your first pull request.
Reference — open when you need them
Suggested order for day 1, day 2, day 3.
Claude Code plugins to install on day 1.
Open an issue at github.com/almaghrib-engineering/quranflow-admin/issues and tag @Kamran-AM. We don't use Slack for this project — GitHub keeps everything in one place.