Building the future of Islamic digital experience
🌟 Star us on GitHub • 🐛 Report Issues • 💬 Join Discussions • 🤝 Contribute
Bridging Faith and Technology for 1.8+ Billion Muslims Worldwide
|
🕌 Religiously Authentic
|
⚡ Cutting-Edge Tech
|
🤝 Community-Focused
|
🔒 Privacy-Centric
|
|
To become the world's leading Islamic digital platform, empowering Muslims globally with authentic religious tools, fostering unity through technology, and preserving Islamic values in the digital age. Keywords: Islamic app, Muslim community, digital Islam, prayer times, Quran reader, Islamic technology, halal software |
Providing comprehensive Islamic digital services that enhance daily religious practice, connect Muslims worldwide, and make authentic Islamic knowledge accessible to everyone, everywhere, at any time. Keywords: Muslim platform, Islamic services, prayer calculator, Zakat calculator, Qibla finder, Islamic community |
🔗 Core Tags:
🌐 Technology Tags:
📱 Platform Tags:
🌍 Community Tags:
📈 SEO Optimization Keywords
Primary Keywords:
- Islamic app, Muslim platform, Islamic digital services
- Prayer times calculator, accurate prayer times, salah times
- Quran reader online, digital Quran, Quran with translation
- Zakat calculator, Islamic finance, halal calculator
- Qibla finder, Mecca direction, Kaaba direction
- Islamic community, Muslim networking, Islamic social platform
Secondary Keywords:
- Adhan times, namaz times, Islamic calendar
- Tafsir, Hadith collection, Islamic knowledge
- Muslim community app, Islamic lifestyle app
- Halal food finder, Islamic education, Arabic learning
- Islamic AI assistant, Muslim chatbot, Islamic Q&A
Technical Keywords:
- Progressive web app Islam, PWA Islamic, offline Islamic app
- React Islamic app, TypeScript Muslim platform
- Open source Islamic software, MIT license Islamic project
Authentic • Accurate • Accessible
🕐 Prayer Times
|
📖 Quran Reader
|
💰 Zakat Calculator
|
🧭 Qibla Finder
|
Innovation meets Islamic tradition
|
|
|
|
Modern technology for timeless values
| Feature | Status | Description |
|---|---|---|
| 📱 Mobile Responsive | ✅ Complete | Optimized for all screen sizes |
| ⚡ Fast Loading | ✅ Complete | Sub-2s load times |
| 🔄 Offline Support | 🚧 Development | Basic offline functionality |
| 📥 App Installation | ✅ Beta | Install as native app |
| 🔔 Push Notifications | 🚧 Development | Prayer time reminders |
| 🌙 Dark Mode | 📋 Planned | Eye-friendly night mode |
frontend/
├── 🎯 src/
│ ├── 🧩 components/ // Reusable UI components
│ │ ├── ui/ // Base UI elements
│ │ ├── forms/ // Form components
│ │ └── islamic/ // Islamic-specific components
│ ├── 📄 pages/ // Application pages
│ │ ├── auth/ // Authentication pages
│ │ ├── dashboard/ // User dashboard
│ │ └── features/ // Feature-specific pages
│ ├── 🎣 hooks/ // Custom React hooks
│ ├── 🔗 services/ // API integration services
│ ├── 🛠️ utils/ // Helper functions
│ └── 🎨 styles/ // Styling and themes
├── 📦 public/ // Static assets
└── ⚙️ config/ // Build configurations |
backend/
├── 🎯 src/
│ ├── 🛣️ routes/ // API endpoints
│ │ ├── auth/ // Authentication routes
│ │ ├── islamic/ // Islamic features routes
│ │ └── community/ // Community features
│ ├── 📊 models/ // MongoDB schemas
│ │ ├── User.ts // User model
│ │ ├── Prayer.ts // Prayer times model
│ │ └── Community.ts // Community model
│ ├── 🔒 middleware/ // Express middleware
│ ├── 🎯 services/ // Business logic
│ ├── 🔧 utils/ // Backend utilities
│ └── 📋 types/ // TypeScript definitions
├── 🧪 tests/ // Test suites
└── 🐳 docker/ // Containerization |
| Technology | Version | Purpose | Status |
|---|---|---|---|
 |
18.2+ | UI Framework | ✅ Implemented |
 |
5.0+ | Type Safety | ✅ Implemented |
 |
3.3+ | Styling | ✅ Implemented |
 |
5.0+ | State Management | ✅ Implemented |
 |
Latest | Progressive Web App | 🚧 In Progress |
| Technology | Version | Purpose | Status |
|---|---|---|---|
 |
20.x | Runtime Environment | ✅ Implemented |
 |
4.18+ | Web Framework | ✅ Implemented |
 |
6.0+ | Database | ✅ Implemented |
 |
9.0+ | Authentication | ✅ Implemented |
 |
24.x+ | Containerization | 📋 Planned |
graph LR
A[👨💻 Developer] --> B[📝 Code Commit]
B --> C[🔍 GitHub Actions]
C --> D[🧪 Tests & Linting]
D --> E[🏗️ Build Process]
E --> F[🐳 Docker Image]
F --> G[☁️ Cloud Deployment]
G --> H[🌐 Live Application]
|
Node.js 18+
|
MongoDB 6+
|
Git
|
# 📥 Clone the repository
git clone https://github.com/yani2298/MuslimHub.git
# 📂 Navigate to project directory
cd MuslimHub# 📦 Install all dependencies (frontend + backend)
npm run install-deps
# ⏱️ This may take 2-3 minutes depending on your connection# 🔧 Create environment file
cp backend/.env.example backend/.env
# ✏️ Edit the .env file with your MongoDB connection
# Default MongoDB URI: mongodb://localhost:27017/muslimhub# 🚀 Start both frontend and backend servers
npm run dev
# 🌐 Application will be available at: http://localhost:3000
# 🔗 Backend API will be available at: http://localhost:5000| Service | URL | Status Check |
|---|---|---|
| 🎨 Frontend | http://localhost:3000 | Should show MuslimHub homepage |
| ⚡ Backend API | http://localhost:5000/health | Should return {"status": "success"} |
| 📊 Database | Local MongoDB | Check connection in terminal logs |
# 🚀 One-command setup with Docker
docker-compose up --build
# ✨ Everything configured automatically🚨 Common Issues & Solutions
# Kill process on port 3000
npx kill-port 3000
# Kill process on port 5000
npx kill-port 5000# Check if MongoDB is running
mongosh --eval "db.runCommand({ ping: 1 })"
# Start MongoDB service (Windows)
net start MongoDB
# Start MongoDB service (macOS with Homebrew)
brew services start mongodb-community# Clear npm cache
npm cache clean --force
# Delete node_modules and reinstall
rm -rf node_modules package-lock.json
npm install
Create a .env file in the backend/ directory with the following configuration:
# 🚀 Server Configuration
PORT=5000
NODE_ENV=development
# 📊 Database Configuration
MONGODB_URI=mongodb://localhost:27017/muslimhub
# 🔐 Authentication Configuration
JWT_SECRET=your_super_secure_secret_key_here
JWT_EXPIRE=30d
REFRESH_TOKEN_SECRET=your_refresh_token_secret
REFRESH_TOKEN_EXPIRE=7d |
# 🕐 Prayer Times API
PRAYER_TIMES_API_KEY=your_prayer_api_key
PRAYER_CALCULATION_METHOD=MWL
# 📖 Quran API
QURAN_API_KEY=your_quran_api_key
QURAN_API_BASE_URL=https://api.quran.com
# 🧭 Geolocation Services
GEOCODING_API_KEY=your_geocoding_api_key
MAPS_API_KEY=your_maps_api_key |
| Setting | Development | Production | Description |
|---|---|---|---|
| JWT_SECRET | 32+ chars | 64+ chars, cryptographically secure | Used for token signing |
| NODE_ENV | development |
production |
Environment mode |
| MONGODB_URI | Local MongoDB | MongoDB Atlas cluster | Database connection |
| CORS_ORIGIN | http://localhost:3000 |
Your domain | Allowed origins |
🏭 Production-Ready Configuration
# 🏭 Production Configuration
NODE_ENV=production
PORT=5000
# 🔒 Secure Database Connection
MONGODB_URI=mongodb+srv://username:[email protected]/muslimhub
# 🔐 Strong Security Keys (Generate with: openssl rand -base64 64)
JWT_SECRET=your_production_jwt_secret_64_characters_minimum
REFRESH_TOKEN_SECRET=your_production_refresh_secret_64_characters_minimum
# 🌐 CORS & Security
CORS_ORIGIN=https://yourdomain.com
ALLOWED_HOSTS=yourdomain.com,www.yourdomain.com
# 📧 Email Configuration (for notifications)
SMTP_HOST=smtp.gmail.com
SMTP_PORT=587
SMTP_USER=[email protected]
SMTP_PASS=your_app_password
# 📊 Monitoring & Analytics
SENTRY_DSN=your_sentry_dsn
GOOGLE_ANALYTICS_ID=your_ga_id
Base URL: http://localhost:5000/api (Development) • https://api.muslimhub.com/api (Production)
| Endpoint | Method | Description | Auth Required |
/auth/register |
 |
Create new user account with email verification | ❌ No |
/auth/login |
|
Authenticate user and return JWT tokens | ❌ No |
/auth/refresh |
|
Refresh access token using refresh token | 🔄 Refresh Token |
/auth/logout |
|
Invalidate user session and tokens | ✅ Yes |
/auth/profile |
 |
Get current user profile information | ✅ Yes |
| Endpoint | Method | Description | Status |
/prayers/times |
|
Get prayer times for specific location and date | ✅ Active |
/prayers/qibla |
|
Calculate Qibla direction from coordinates | ✅ Active |
/prayers/settings |
|
Save user's prayer time preferences | 🚧 Development |
/prayers/notifications |
 |
Update prayer notification settings | 📋 Planned |
| Endpoint | Method | Description | Features |
/quran/chapters |
|
List all 114 Quran chapters with metadata | 📊 Pagination |
/quran/chapter/:id |
|
Get specific chapter with verses and translations | 🌐 Multi-language |
/quran/verse/:chapter/:verse |
|
Get specific verse with detailed information | 🎵 Audio included |
/quran/search |
|
Search Quran text with filters and highlighting | 🔍 Full-text search |
/quran/bookmarks |
|
Save and manage user bookmarks | 👤 User-specific |
| Endpoint | Method | Description | Accuracy |
/zakat/calculate |
|
Calculate Zakat based on assets and debts | 💎 High precision |
/zakat/rates |
|
Get current gold/silver rates and nisab values | 📈 Real-time |
/zakat/history |
|
View user's Zakat calculation history | 📊 Analytics |
| Endpoint | Method | Description | Status |
/community/forums |
|
List available discussion forums | 📋 Planned |
/community/posts |
|
Create new community posts | 📋 Planned |
/community/events |
|
Find local Islamic events and gatherings | 📋 Planned |
🔍 Example API Calls
curl -X GET "http://localhost:5000/api/prayers/times?lat=40.7128&lng=-74.0060&date=2024-01-01"curl -X POST "http://localhost:5000/api/auth/register" \
-H "Content-Type: application/json" \
-d '{
"name": "Ahmed Ali",
"email": "[email protected]",
"password": "SecurePassword123!"
}'curl -X GET "http://localhost:5000/api/quran/search?q=patience&translation=en.sahih"
Every contribution matters in building a better digital Islamic experience
|
🐛 Bug Reports
|
✨ Feature Ideas
|
💻 Code Development
|
📚 Documentation
|
graph LR
A[🍴 Fork Repository] --> B[🌟 Create Feature Branch]
B --> C[💻 Make Changes]
C --> D[✅ Test Thoroughly]
D --> E[📝 Commit Changes]
E --> F[🚀 Push to Fork]
F --> G[🔄 Create Pull Request]
G --> H[🎉 Code Review & Merge]
| Area | Standard | Tool/Practice |
|---|---|---|
| Code Style | Consistent formatting | ESLint + Prettier |
| Type Safety | Strict TypeScript | No any types |
| Testing | High coverage | Jest + React Testing Library |
| Commits | Conventional commits | feat:, fix:, docs: |
| Islamic Accuracy | Scholar verification | Community review process |
Special Considerations for Islamic Features
- Religious Accuracy: All Islamic content must be verified for accuracy
- Cultural Sensitivity: Consider diverse Muslim communities globally
- Scholarly Review: Major religious features require scholarly input
- Respectful Implementation: Maintain dignity in all Islamic content
- Accessibility: Ensure features work for Muslims worldwide
|
|
| Feature | Progress | Expected Completion | Priority |
|---|---|---|---|
| 🤖 Islamic AI Assistant |  |
Q2 2025 |  |
| 🌐 Community Platform |  |
Q3 2025 |  |
| 📱 Mobile Apps |  |
Q4 2025 | |
| 🔍 Semantic Search |  |
Q1 2025 | |
timeline
title MuslimHub Development Roadmap 2025
Q1 2025 : Beta Launch
: Enhanced UI/UX
: Semantic Search
: Performance Optimization
Q2 2025 : AI Assistant
: Advanced Analytics
: Multi-language Support
: Mobile Optimization
Q3 2025 : Community Features
: Local Events
: Study Groups
: Scholar Integration
Q4 2025 : Mobile Apps
: Advanced Features
: Global Scaling
: Enterprise Features
|
⚡ Performance
|
🔒 Security
|
🛡️ Privacy
|
🌍 Accessibility
|
|
🐛 Technical Issues
|
💬 Community Support
|
📧 Direct Contact
|
Free and Open Source - Built with transparency for the Muslim community
This project is licensed under the MIT License - see the LICENSE file for full details.
"وَاعْتَصِمُوا بِحَبْلِ اللَّهِ جَمِيعًا وَلَا تَفَرَّقُوا"
"And hold firmly to the rope of Allah all together and do not become divided"
- Quran 3:103
🤲 Built with love and dedication for the global Muslim Ummah
🌍 Serving Muslims worldwide with authentic Islamic technology
🤝 United in faith, innovation, and community
|
Show Support Star our project and help us reach more Muslims worldwide |
Join Development Help build the future of Islamic technology |
Report Bugs Help us improve by reporting issues |
Share Ideas Participate in community discussions |
This project is currently in active beta development. We're continuously adding features and improvements.
Your feedback, contributions, and support help us build better tools for the Muslim community worldwide.
🌟 May Allah (SWT) bless this project and benefit the entire Ummah
جزاكم الله خيراً - May Allah reward you all with good