Skip to content

MosqueAPI is an open-source platform providing comprehensive mosque data through RESTful endpoints. It enables developers to integrate mosque locations, prayer times, capacity info, events, and services into Islamic apps. Features include real-time updates, mosque admin, and verified data for accurate Muslim community engagement worldwide.

License

Notifications You must be signed in to change notification settings

ummahbuild/mosqueAPI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mosque.API

Comprehensive Islamic Center Database & Prayer Times API

Mosque.API is an open-source platform that enables mosque leaders to manage and update their mosque information, which can then be integrated into prayer apps, mosque finders, and other Islamic applications. It provides a centralized database for mosque data including prayer times, capacity information, events, services, and real-time updates.


Overview

Features

  • RESTful API — Mosque directory, search, prayer times, events, capacity, reviews, and more
  • Real-time updates — Webhooks and push updates for prayer times and announcements
  • Verified data — Official onboarding and mosque-claimed listings
  • Rich data model — Capacity, facilities, accessibility, imams, Ramadan schedules, donations
  • Developer-first — OpenAPI spec, comprehensive docs, and SDK-ready responses

Monorepo Structure

Package Description
apps/api REST API service (Node.js)
apps/docs API documentation site
apps/landing Marketing/landing page (mosque.api)
resources Guides, use cases, pillar content, and developer resources

Quick Links


Getting Started

Prerequisites

  • Node.js 18+
  • (Optional) Docker for running API and docs locally

Install and run

# Clone the repo
git clone https://github.com/ummah-build/MosqueAPI.git
cd MosqueAPI

# Install all workspaces
npm install

# Run API (development)
npm run dev --workspace=apps/api

# Run API docs
npm run dev --workspace=apps/docs

# Run landing page
npm run dev --workspace=apps/landing

See each package’s README for more options (e.g. production build, env vars).


Project Status & TODOs

High-level roadmap and per-area tasks are tracked in:

  • TODO.md — Master todo list and links to section-specific TODOs

Section-specific task lists:


API Summary

Area Endpoints
Core GET/POST/PUT/DELETE /api/mosques, GET /api/mosques/{id}
Search /api/mosques/search, /api/mosques/nearby, /api/mosques/filter
Prayer /api/mosques/{id}/prayer-times, /api/mosques/{id}/jamaat-times
Events & Services /api/mosques/{id}/events, /api/mosques/{id}/services
Imams & Leadership /api/mosques/{id}/imams, /api/imams/{id}
Capacity & Attendance /api/mosques/{id}/capacity, /api/mosques/{id}/attendance
Reviews & Ratings /api/mosques/{id}/reviews, /api/mosques/{id}/ratings
Facilities /api/mosques/{id}/facilities, /api/mosques/{id}/accessibility
Notifications /api/mosques/{id}/subscribe, /api/mosques/{id}/announcements
Donations /api/mosques/{id}/donation-info, /api/mosques/{id}/donations
Media /api/mosques/{id}/photos, /api/mosques/{id}/videos, /api/mosques/{id}/floor-plan
Historical /api/mosques/{id}/history, /api/mosques/{id}/architecture
Ramadan /api/mosques/{id}/ramadan-schedule, /api/mosques/{id}/taraweeh-info
Webhooks POST /api/webhooks/register, DELETE /api/webhooks/{id}
Verification /api/mosques/{id}/claim, /api/mosques/{id}/verify

Full reference: API Documentation.


Use Cases & Partners

  • PRAYATTHEMosque.com — Find nearest mosque
  • PRAYSAP.com — Accurate prayer times at mosques
  • Mosque finder and building-planning apps
  • Integration with Google Maps, Mapbox, and other map providers
  • Women-focused mosque apps and women’s space discovery
  • Donation platforms and mosque capacity visibility
  • Archive of mosque database and lectures

Data Sources & Integrations


Security

  • Secrets: Do not commit .env, .env.local, or any file with API keys or passwords. They are in .gitignore. Use environment variables (e.g. NEXT_PUBLIC_API_URL, PORT) for config.
  • History: Repo history was rewritten to a single commit; no device paths (e.g. /Users/...) or build artifacts (.next) are in the current commit. After pushing, use git push --force origin main so the remote matches.

Pushing after history rewrite

If the repo history was rewritten to a single commit (e.g. to remove leaked paths), update the remote with:

git push --force origin main

License

MIT © ummah.build. See LICENSE.

About

MosqueAPI is an open-source platform providing comprehensive mosque data through RESTful endpoints. It enables developers to integrate mosque locations, prayer times, capacity info, events, and services into Islamic apps. Features include real-time updates, mosque admin, and verified data for accurate Muslim community engagement worldwide.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages