Repository navigation
Developer Setup
github-actions[bot] edited this page Nov 15, 2026
·
3 revisions
- Node.js 24 (the scripts import the TypeScript data files directly)
- Git 2.40+
git clone https://github.com/Bosaj/prophets-family-tree.git
cd prophets-family-tree
npm install
npm run dev # http://localhost:5173npm test # Vitest: pages, data rules, layout, fasting days, Spanish keys (104 tests)
npm run build # type-check and production build into dist/
npm run verify:sources # people and links against the Qur'an and Hadith sources
npm run audit:content # every dataset: Qur'an refs, typed verses, hadith numbers, DOIs
npm run verify:duas # every Arabic supplication and quote against its hadith (network)See Accuracy & sources for what the audits check.
-
GitHub Pages:
.github/workflows/deploy.ymlbuilds with the base path/prophets-family-tree/on every push tomain. Public assets must useimport.meta.env.BASE_URL(or be imported so Vite rewrites them); an absolute/img/...path 404s on Pages. -
Vercel: the mirror at https://shajara-prophets.vercel.app builds from
mainwith the root base path. -
Morocco month check:
.github/workflows/morocco-month.ymlrunsscripts/check-morocco-month.mjsevery evening and opens an issue when the next month must be added toMOROCCO_STARTS(try it withnode scripts/check-morocco-month.mjs --dry --today=2026-12-08). -
Wiki: pages live in
docs/wiki/;.github/workflows/wiki-sync.ymlcopies them to the GitHub wiki when they change onmain.
- Branch from
main, commit with Conventional Commits. - Every new fact needs a source and a source level; never upgrade a level.
- New user-visible text goes into Arabic, English, French and Spanish:
tx(lang, en, fr, ar, es)for interface text,strings.tsfor shared keys. -
Changing an English data text? Its Spanish version lives in
src/data/es/long/<dataset>.jsonundertextKey(english). Move the entry to the new key (src/data/es/long/coverage.test.tsfails otherwise). - Arabic hadith wording is copied from the source, never typed, and added to
scripts/verify-duas.mjs. - Releases follow Semantic Versioning: bump
package.json, add a CHANGELOG entry, tagvX.Y.Zand publish the release.
Interactive Prophets Family Tree & Quranic Lineage Documentation — Maintained by @Bosaj